Improve the getting started section for users by simplifying it. #845
Conversation
|
@AtsushiSakai please review this PR. |
|
@AtsushiSakai Could you please review it so I can work on other sections? |
docs/getting_started_main.rst
Outdated
|
|
||
| Each sample code is written in Python3 and only depends on some standard modules for readability and ease of use. | ||
| Based on the principles of collaboration and knowledge sharing, PythonRobotics is an open source software (OSS). | ||
| This project includes a selection of practical algorithms that are widely adopted across academic and industrial domains, keeping you on the cutting edge of robotics development. |
There was a problem hiding this comment.
Is it possible to describe about License?
There was a problem hiding this comment.
I'm a bit confused, Could you please explain briefly what I have to describe about licenses?
Can you tell me what type of license I have described? Should I explain the MIT license?
I'm a newbie to the open source world but I really want to contribute.
There was a problem hiding this comment.
Just describing MIT license is fine.
docs/getting_started_main.rst
Outdated
|
|
||
| Each sample code is written in Python3 and only depends on some standard modules for readability and ease of use. | ||
| Based on the principles of collaboration and knowledge sharing, PythonRobotics is an open source software (OSS). | ||
| This project includes a selection of practical algorithms that are widely adopted across academic and industrial domains, keeping you on the cutting edge of robotics development. |
There was a problem hiding this comment.
Is it possible to describe about minimum dependency policy?
There was a problem hiding this comment.
ok i'm correcting
There was a problem hiding this comment.
Here also please explain a little bit what exactly I have to describe.
There was a problem hiding this comment.
Describing like this chapter
(Ref: https://arxiv.org/pdf/1808.10703.pdf )
is fine.
Co-authored-by: Atsushi Sakai <asakai.amsl+github@gmail.com>
Co-authored-by: Atsushi Sakai <asakai.amsl+github@gmail.com>
Co-authored-by: Atsushi Sakai <asakai.amsl+github@gmail.com>
Co-authored-by: Atsushi Sakai <asakai.amsl+github@gmail.com>
move previous Introduction text to the -----> “Getting started' page”.
#843
change