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

Update README #102

Closed
szapp opened this issue Feb 13, 2017 · 3 comments
Closed

Update README #102

szapp opened this issue Feb 13, 2017 · 3 comments
Labels
code enhancement major
Milestone
v1.0.0

Comments

@szapp
Copy link
Owner

szapp commented Feb 13, 2017 •
edited

The README barely touches on how free aiming is actually implemented. This information should be added to make the core functionality more accessible.
Also the new file structure should be explained.
@szapp szapp mentioned this issue Feb 27, 2017
Closed
@szapp szapp added blocker and removed minor labels Feb 27, 2017
@szapp
Copy link
Owner Author

szapp commented Jul 10, 2017

Completely rework the README from scratch.

@szapp szapp added this to the v1.0.0 milestone Jul 10, 2017
@szapp
Copy link
Owner Author

szapp commented Jul 10, 2017 •
edited

Also, give a clear overview of the functions and how they interact and depend on each other. Preferably using a simple and intuitive diagram.

UPDATE: Done.

@szapp szapp added major and removed blocker labels Jul 10, 2017
@szapp
Copy link
Owner Author

szapp commented Jul 15, 2017

It would be a good idea, to add a separate README into the _intern/ directory to free up the root README and give information on how the internal stuff works.
Another README for the config in the config/ directory would also be a good idea, leaving the root README for installation instructions and general information.

@szapp szapp closed this as completed in 86cf59a Sep 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code enhancement major
Projects
None yet
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@szapp