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

Add user guide to README.md #2

Open
eecavanna opened this issue Aug 21, 2024 · 0 comments
Open

Add user guide to README.md #2

eecavanna opened this issue Aug 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@eecavanna
Copy link

I see that this repository contains files, but I don't understand how I can use them. I suggest adding a "Usage" or "User Guide" section to README.md that includes instructions someone can follow to do something using the contents of this repo.

For example:

Usage

  1. Identify the thing you want to make by looking at the targets defined in Makefile
  2. Run $ make <target>
  3. View the result in <directory>
@eecavanna eecavanna added the documentation Improvements or additions to documentation label Aug 21, 2024
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

1 participant