summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index 45f56f1..f6784f2 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
--- Slice It Off! --
+-- Slice It Off! --
Description:
@@ -7,3 +7,24 @@ Description:
get. If you hit enemies while slicing you lose healt. There will be
also bonuses to boost the scores.
+Installing:
+
+ One can use provided `./dev.sh` shell script to buid and install any
+ versionof game:
+ - `git clone https://git.hix.fi/scliceitoff.git`
+ - `cd sliceitoff`
+ - `./dev.sh install`
+
+ Distribution package can be installed normally:
+ - `pipx install sliceitoff.*.tar.gz`
+
+Developement:
+
+ Project makes heavy use of poetry build and dependencies control
+ system. Many shortcuts can be run easily from `./dev.sh` script:
+ - `./dev.sh`
+ - `./dev.sh dev`
+ - `./dev.sh pytest`
+ - `./dev.sh covff`
+ - `./dev.sh all`
+ - etc