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

Better README #97

Open
4 tasks
wusatosi opened this issue Jan 6, 2025 · 0 comments · May be fixed by #111
Open
4 tasks

Better README #97

wusatosi opened this issue Jan 6, 2025 · 0 comments · May be fixed by #111
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers mentoring available Guidance and support available if required

Comments

@wusatosi
Copy link
Member

wusatosi commented Jan 6, 2025

Current README is full of TODOs and is out of sync with new tools we've introduced.

Improvement should include:

  • Cleanup TODOs leftover in the current README
  • Include short documentation for setting up pre-commit
  • Include short documentation for using cmake presets
  • Include short documentation for using codespace.

A restructure could desired in accordance to other beman repos.

I am available to explaining preset design and setting up pre-commit. Feel free to comment on this thread if you have any questions and I will do my best to respond. However I am not available for technical writing.

@wusatosi wusatosi added documentation Improvements or additions to documentation good first issue Good for newcomers mentoring available Guidance and support available if required labels Jan 6, 2025
@wusatosi wusatosi linked a pull request Feb 2, 2025 that will close this issue
11 tasks
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 mentoring available Guidance and support available if required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant