Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
codesoap committed Nov 21, 2022
1 parent d1ea122 commit d81a2c4
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
![screenshot of overview page](./demo/overview.png)
![screenshot of details page](./demo/details.png)

mycolog helps you keep an overview of your mushroom cultivation
projects. It can store notes for each component, so that it's easier to
remember which experiments succeeded and which failed. Genetics can be
traced through family trees.

# Installation
You can download the precompiled program from the
[releases page](https://github.com/codesoap/mycolog/releases).

In order to get family trees displayed, you need to have Graphviz
installed. You can download it [here](https://graphviz.org/download/).

If you want to compile the program yourself, do this:

```bash
git clone git@github.com:codesoap/mycolog.git
cd mycolog
go install
# The binary is now at ~/go/bin/mycolog.
```

0 comments on commit d81a2c4

Please sign in to comment.