mravi/uncloud-mravi
1
0
Fork 0
forked from uncloud/uncloud
Code Issues Pull requests Projects Releases Wiki Activity

Update hacking docs

Browse source
This commit is contained in:
Nico Schottelius 2020-01-15 10:53:22 +01:00
parent b877ab13b3
commit 26d5c91625
1 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
uncloud/docs/source/hacking.rst
View file

@ -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