From 26d5c916256ccf91c99de92ae6a80353d58b4720 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Wed, 15 Jan 2020 10:53:22 +0100 Subject: [PATCH] Update hacking docs --- uncloud/docs/source/hacking.rst | 30 +++++++++++++++++++----------- 1 file changed, 19 insertions(+), 11 deletions(-) diff --git a/uncloud/docs/source/hacking.rst b/uncloud/docs/source/hacking.rst index 2df42a7..d198126 100644 --- a/uncloud/docs/source/hacking.rst +++ b/uncloud/docs/source/hacking.rst @@ -1,17 +1,25 @@ Hacking ======= -How to hack on the code. +Using uncloud in hacking (aka development) mode. -[ to be done by Balazs: -* make nice -* indent with shell script mode +Get the code +------------ +.. code-block:: sh + :linenos: -] + git clone https://code.ungleich.ch/uncloud/uncloud.git -* git clone the repo -* cd to the repo -* Setup your venv: python -m venv venv -* . ./venv/bin/activate # you need the leading dot for sourcing! -* Run ./bin/ucloud-run-reinstall - it should print you an error - message on how to use ucloud + + +Install python requirements +--------------------------- +You need to have python3 installed. + +.. code-block:: sh + :linenos: + + cd uncloud! + python -m venv venv + . ./venv/bin/activate + ./bin/uncloud-run-reinstall