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.

Sign up for GitHub

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

Jump to bottom

Feature: create doc pages for more concrete manual usage #6

Open
pxlphile opened this issue May 14, 2018 · 0 comments
Open

Feature: create doc pages for more concrete manual usage #6

pxlphile opened this issue May 14, 2018 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@pxlphile
Copy link
Owner

Besides the README. md (which tells about the technical background of the project) there is close to none documentation about HOW to use the software.

I suggest to set up doc pages which iterate on the following topics

  • what to expect from the software
  • building an artefact
  • running the software
  • incorporating the existing technical background information
@pxlphile pxlphile added enhancement New feature or request good first issue Good for newcomers labels May 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pxlphile