From 5ba455dc923ee5cdcceb9da5084af0575419e9e8 Mon Sep 17 00:00:00 2001 From: krateng Date: Tue, 21 Dec 2021 20:11:51 +0100 Subject: [PATCH] Added initial basic dev instructions, GH-57 --- DEVELOPMENT.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..0ac22fd --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,13 @@ +# Basic Development Instructions + +After you've cloned the repository, traverse into the `maloja` folder with `cd maloja`. + +Make sure all dependencies are installed. +Your system needs a few packages, on Alpine Linux these should all be installed with `sh install_alpine.sh`. +Python dependencies can be installed with `pip install -r requirements.txt` + +## Running the server + +You can quickly run the server with all your local changes with `python3 -m maloja.proccontrol.control run`. + +You can also build the package with `pip install .`.