search

KodlabPenn / kodlab_mjbots_sdk

Repo for kodlab SDK for use with mjbots ecosystem
Other
8 stars 7 forks source link

Replace long README with wiki #46

Open ethanmusser opened 2 years ago

ethanmusser commented 2 years ago

The README.md is getting kind of long and difficult to navigate. It might be time to break this out into several wiki pages. Something like:

  1. Setup
    1. Raspberry Pi
    2. Laptop
      1. Toolchain
      2. LCM
    3. Motors
  2. Usage
    1. RobotBase
      1. Accessing Robot State
      2. User-Defined Robots
    2. MjbotsControlLoop
      1. LCM Logging
      2. LCM Input
      3. Control Loop Options (summary of options, including soft start)
    3. Behavior & MjbotsBehaviorLoop (when ready)
  3. Building & Deploying Code
jdcaporale commented 2 years ago

I agree and was going to bring this up. This structure looks good to me

On Thu, Aug 4, 2022, 7:47 PM Ethan J. Musser @.***> wrote:

The README.md is getting kind of long and difficult to navigate. It might be time to break this out into several wiki pages. Something like:

  1. Setup
    1. Raspberry Pi
    2. Laptop
      1. Toolchain
      2. LCM
    3. Motors
  2. Usage
    1. RobotBase
      1. Accessing Robot State
      2. User-Defined Robots
    2. MjbotsControlLoop
      1. LCM Logging
      2. LCM Input
      3. Control Loop Options (summary of options, including soft start)
    3. Behavior & MjbotsBehaviorLoop (when ready)
  3. Building & Deploying Code

— Reply to this email directly, view it on GitHub https://github.com/KodlabPenn/kodlab_mjbots_sdk/issues/46, or unsubscribe https://github.com/notifications/unsubscribe-auth/AFBS4GPS2VVWLN65US3LFCTVXRI7LANCNFSM55UIODUQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>