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

updated README.md to add installation and usage instructions beginner friendly #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

siddharthksah
Copy link

Description

This PR updates the README file with detailed installation and usage instructions, helping users to get started with rs_bag2image more easily. The PR also enhances the overall readability and presentation of the README.

Changes

  • Added a section on prerequisites, with links to installation guides for all dependencies.
  • Added step-by-step installation instructions, including how to clone the repo, create a build directory, generate a makefile with CMake, and build the project with Make.
  • Added instructions on how to use rs_bag2image.
  • Improved formatting and organization to enhance readability and clarity.
  • Added a header image to make README visually appealing.

… friendly

Added the installation section with step by step guide on how to use the code on local system for beginners
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant