Needs a better README / wiki - Githubissues

darrenarmstrong85 / scientist

q scientist library implementation

Apache License 2.0

0 stars 0 forks source link

Needs a better README / wiki #5

Open darrenarmstrong85 opened 7 years ago

darrenarmstrong85 commented 7 years ago

As a scientist library user, a maintained README will help me to use the code

Some sort of documentation of how to use library, and how to run tests would be good.

Plan

Add documentation for:

what this library aims to do
how to run library and test code
how to create new experiments
how to use logging facilities
areas that are not yet supported (compared to e.g. Ruby Scientist implementation)

Done

Above documentation added