From 8e159c8be134393d08c85b7b0594269877721cc7 Mon Sep 17 00:00:00 2001 From: Nico Schottelius Date: Sun, 8 Dec 2019 14:20:26 +0100 Subject: [PATCH] add hacking template --- ucloud/docs/source/hacking.rst | 16 ++++++++++++++++ ucloud/docs/source/index.rst | 1 + 2 files changed, 17 insertions(+) create mode 100644 ucloud/docs/source/hacking.rst diff --git a/ucloud/docs/source/hacking.rst b/ucloud/docs/source/hacking.rst new file mode 100644 index 0000000..976970b --- /dev/null +++ b/ucloud/docs/source/hacking.rst @@ -0,0 +1,16 @@ +Hacking +======= +How to hack on the code. + +[ to be done by Balazs: + +* make nice +* indent with shell script mode + +] + +* git clone the repo +* cd to the repo +* Setup your venv: python -m venv venv +* Run ./bin/ucloud-run-reinstall - it should print you an error + message on how to use ucloud diff --git a/ucloud/docs/source/index.rst b/ucloud/docs/source/index.rst index 879ac32..b31cff3 100644 --- a/ucloud/docs/source/index.rst +++ b/ucloud/docs/source/index.rst @@ -16,6 +16,7 @@ Welcome to ucloud's documentation! admin-guide user-guide/how-to-create-an-os-image-for-ucloud troubleshooting + hacking Indices and tables