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

Write getting started guide #160

Open
4 tasks
acrosman opened this issue May 15, 2022 · 0 comments
Open
4 tasks

Write getting started guide #160

acrosman opened this issue May 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@acrosman
Copy link
Owner

Summary
This project really needs a better getting started guide as part of the repo itself.

Proposed Solution
I wrote one for my blog, but a version should really get folded in here.

  • Update and re-write text as needed into an Markdown file.
  • Put file into documentation directory.
  • Copy images from blog to repo (or add new ones). I give permission to anyone who wants to copy them even though they are shifting licensing in the process.
  • Link from current README and any other adjustments to tighten the README itself.
@acrosman acrosman added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels May 15, 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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant