From da33fc2f82a2919f9af7c7d1c8510c37435c5181 Mon Sep 17 00:00:00 2001
From: Viljami Ilola <+@hix.fi>
Date: Mon, 8 Apr 2024 18:47:32 +0300
Subject: background

---
 README.txt | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.txt

(limited to 'README.txt')

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..917ae41
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,30 @@
+-- Slice It Off! --
+
+Description:
+
+	Small game where goal is to beat hiscores. Score is gained by
+	slicing parts of playing area off. Faster you do it more score you
+	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
-- 
cgit v1.2.3