From b5f50b7d3638aa04127bcac55069ed48935f993b Mon Sep 17 00:00:00 2001 From: Viljami Ilola <+@hix.fi> Date: Fri, 29 Mar 2024 18:51:37 +0200 Subject: update README.md --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3