summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..41d28c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+## Develop
+You need to have nix with flake feature configured on your system.
+
+Then you run `nix develop` command in your terminal to enter development shell.
+
+In it you can run `cargo run` to test this program.
+** Remember to give a testing music direcoty,
+so you don't break your music library by mistake.
+
+## Install
+### Steam Deck
+```
+git clone https://git.jptrzy.xyz/ogg-tagger
+cd ogg-tagger
+
+nix-build default.nix
+nix profile install ./result
+```
+
+### Others
+Figure it out yourself 🥲
Software created with 💖