search

NASA-Tensegrity-Robotics-Toolkit / NTRTsim

The NASA Tensegrity Robotics Toolkit Simulator, a physics based simulator to research the design and control of tensegrity robots.
Apache License 2.0
162 stars 81 forks source link

Review my README #81

Open srlessard opened 10 years ago

srlessard commented 10 years ago

I just pushed a README for my escape module to my dev folder (src/dev/steve/Escape_T6). If any of you could give it a quick read through and let me know what to change, I'd greatly appreciate it.

brtietz commented 10 years ago

Great work! If everyone did this, the code would be much better documented. =)

Major comments: 1) It would be great if you could format this so its a page in our Doxygen documentation (see README.dox in src). This will allow you to link to some of the relevant files/other document pages.

2) Is there a way to get your python documentation into Doxygen? That would be very helpful as well.

Minor comments: You swapped the vowels in my last name, its Mirletz ntrtusers@lists.nasa.gov is probably the better list for questions, that way more users can learn from each other's questions.