Skip to content

Commit

Permalink
WIP: Try out improved GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
codesoap committed Aug 8, 2024
1 parent ab589ec commit e0f1b0c
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,28 @@ 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.

<video style="max-width:100%" controls>
<source src="https://github.com/codesoap/mycolog/releases/download/v0.1.0/demo.mp4">
Your browser does not support playing this video.
</video>

# 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\<your-username>\mycolog.sqlite3`. Make sure to create backups
of this file, so that your data is not lost when your computer breaks.

# 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)

0 comments on commit e0f1b0c

Please sign in to comment.