Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Required #15

Open
namikxgithub opened this issue Jun 12, 2023 · 5 comments
Open

Documentation Required #15

namikxgithub opened this issue Jun 12, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@namikxgithub
Copy link

namikxgithub commented Jun 12, 2023

  • Could anyone please provide with some documentation about the project and its architecture.
    Would really help with newcomers to get started with the development.
  • Please mention the requirements to be installed before building the project as well.
@namikxgithub namikxgithub added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 12, 2023
@namikxgithub
Copy link
Author

  • Also in the readme, under the 'Make the Package' heading, it is still written catkin workspace which might be wrong.
  • Add another text field to navigate back to the workspace directory for ease of use.

@namikxgithub
Copy link
Author

@topguns837 @jasmeet0915 could you please take a look at this?

@oicaroabreu
Copy link
Contributor

Hi! Is there a standart that you would like the documentation to be in? Or just simple and direct documentation is enough?

@jasmeet0915
Copy link
Contributor

Hi @oicaroabreu ! Simple and direct documentation would work but I guess it would be better to use the Readme template from our other project repos for consistency. For reference you can have a look at: https://github.com/atom-robotics-lab/MR-Robot

@oicaroabreu
Copy link
Contributor

I'm waiting on your PR review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants