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

Improve AP.exe documentation #130

Closed
atruskie opened this issue Oct 17, 2017 · 0 comments
Closed

Improve AP.exe documentation #130

atruskie opened this issue Oct 17, 2017 · 0 comments
Labels
enhancement help wanted

Comments

@atruskie
Copy link
Member

atruskie commented Oct 17, 2017 •
edited
Loading

Documentation for AP.exe is particularly sparse.

When we distribute our binary it is often hard to use without said documentation.

We should add a /docs folder and add markdown files that explain:

  • Usage of AP.exe
  • How to run our most important analyses
  • How to interpret output data formats
  • ... (other things too)
atruskie added a commit that referenced this issue Oct 30, 2017
@atruskie
Added a workflow diagram
38582d5 
Initial work for #130
@atruskie atruskie mentioned this issue Oct 30, 2017
Closed
@atruskie atruskie mentioned this issue Dec 21, 2017
Closed
31 tasks
atruskie added a commit that referenced this issue Jan 30, 2018
@atruskie
Added a ton of documentation
cddf318 
Closes #130
This incorporates @towsey's two manual documents into a docs folder that will eventually be a microsite.
The documentation is far far far from finished - but it is a good a decent start.
Closing #130 because we'll open more specific issues as we go on.
Original hash: 3fcd973
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@atruskie