From bd51224e13dc22a46da36f3aa3bbe5ca9ce0749b Mon Sep 17 00:00:00 2001 From: codesoap Date: Thu, 8 Aug 2024 14:33:02 +0200 Subject: [PATCH] Improve READMEs --- README.md | 11 +++++++---- docs/README.md | 24 ++++++++++++++++++++++-- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 15d6988..3165960 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,15 @@ -![screenshot of overview page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/overview.png) -![screenshot of details page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/details.png) -![demo video](https://github.com/codesoap/mycolog/releases/download/v0.1.0/demo.mp4) - 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. +Visit [codesoap.github.io/mycolog](https://codesoap.github.io/mycolog/) +to see a video introduction to mycolog. + +![screenshot of overview page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/overview.png) + +![screenshot of details page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/details.png) + # Installation You can download the precompiled program from the [releases page](https://github.com/codesoap/mycolog/releases). diff --git a/docs/README.md b/docs/README.md index a0a677f..5b43468 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,13 +7,33 @@ mycolog is free and open software and does not connect to the internet. Your data stays on your computer alone and there is no risk of losing it to a discontinued web service. + + # Installation -Download mycolog for Windows: [mycolog_0.1.0_Windows_amd64.zip](https://github.com/codesoap/mycolog/releases/download/v0.1.0/mycolog_0.1.0_Windows_amd64.zip) +Download mycolog for Windows: +[mycolog.exe](https://github.com/codesoap/mycolog/releases/download/v0.2.0/mycolog.exe) + +In order to see family trees, **you also need to install Graphviz**. You +can download it [here](https://graphviz.org/download/#windows). -In order to see family trees, you also need to install Graphviz. You can download it [here](https://graphviz.org/download/#windows). +To build mycolog for a different operating system and more, take a look +at [the GitHub page](https://github.com/codesoap/mycolog?tab=readme-ov-file#installation). # Backups mycolog stores all its data in a single file. On Windows you'll find it in your user profile folder, usually `C:\Users\\mycolog.sqlite3`. Make sure to create backups of this file, so that your data is not lost when your computer breaks. + +On Linux and other unix-like operating systems, you'll find the file at +`XDG_DATA_HOME`, if this environment variable is set. Otherwise it will +be located at `~/.local/share/mycolog.sqlite3`. + +# Screenshots +![screenshot of overview page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/overview.png) + +![screenshot of details page](https://github.com/codesoap/mycolog/releases/download/v0.2.0/details.png)