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

DOCUMENT KRUN! #57

Closed
vext01 opened this issue Oct 14, 2015 · 7 comments
Closed

DOCUMENT KRUN! #57

vext01 opened this issue Oct 14, 2015 · 7 comments
Assignees
@snim2
Labels
enhancement medium priority (a clear improvement but not a blocker)
Milestone
initial submission

Comments

@vext01
Copy link
Member

vext01 commented Oct 14, 2015

Krun is becoming complicated. We should document it.
@snim2 snim2 mentioned this issue Oct 26, 2015
Merged
@snim2
Copy link
Collaborator

snim2 commented Oct 26, 2015

This needs a couple of small changes to close:

  • Check examples/ works on BSD and make any necessary changes
  • Add documentation for BSD to examples/README.md
  • Move the information in examples/README.md to the main README

@snim2 snim2 self-assigned this Oct 26, 2015
@snim2
Copy link
Collaborator

snim2 commented Oct 27, 2015

Also:

@snim2
Copy link
Collaborator

snim2 commented Oct 27, 2015

Document the mk_graphs.py script. Requires:

  • matplotlib
  • statsmodels

@snim2
Copy link
Collaborator

snim2 commented Oct 28, 2015

For Linux, prefer adduser to useradd

This was referenced Oct 29, 2015
Merged
Closed
@vext01
Copy link
Member Author

vext01 commented Nov 5, 2015

Are we happy with the level of documentation at present? Shall we close this?

@vext01 vext01 added this to the Ready to publish milestone Nov 5, 2015
@snim2
Copy link
Collaborator

snim2 commented Nov 5, 2015

The original plan was to move this out of krun/examples/README.md and into krun/README.md once we have included some BSD notes. You can move it over now if you wish and put the other work in with Issue #87 ?

@vext01
Copy link
Member Author

vext01 commented Nov 5, 2015

Sounds sensible.

@snim2 snim2 mentioned this issue Nov 5, 2015
Merged
@vext01 vext01 closed this as completed in #94 Nov 6, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@snim2 snim2

Labels
enhancement medium priority (a clear improvement but not a blocker)
Projects
None yet
Milestone
initial submission
Development

No branches or pull requests
2 participants
@snim2 @vext01