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

Suggestions with README #7

Open
Jash-Shah opened this issue Sep 30, 2022 · 0 comments
Open

Suggestions with README #7

Jash-Shah opened this issue Sep 30, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Jash-Shah
Copy link
Collaborator

Good start on the README. The formatting and instructions are apt.

Necessary changes:

  • Add a better initial description. mention 3D mesh reconstruction and PCL and ROS.
  • Also improve the 'about the project' description. You can make it more elaborate.
  • Add a GIF immediately below the initial descp to attract people who view ur project
  • Add more GIFs, Videos, Code flowcharts, photos, equations throughout the README
  • Add GIF of running the commands with its output mentioned in the execution section
  • Fix all typos
  • Add links to the notes you made in the resources
  • Link to the algorithms mentioned in Future Work

Optional changes:

  • Make a "Problems faced.md" where you list all of the major snags you faced(like in ROS launch) and mention the solutions or links to them on forums.
  • Add a project flow diagram describing how you implemented everything throughout Eklavya from the learning to ROS, PCL, pcl-ros, algorithms etc
@Jash-Shah Jash-Shah added the documentation Improvements or additions to documentation label Sep 30, 2022
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
Projects
None yet
Development

No branches or pull requests

2 participants