From d138bb1a72091c7b41b9cf77b02b7b53f7d85da1 Mon Sep 17 00:00:00 2001 From: David Boreham Date: Tue, 20 Dec 2022 19:15:36 -0700 Subject: [PATCH] Add warning on user mode install --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2deac75d..49a7f2f5 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ Stack Orchestrator allows building and deployment of a Laconic stack on a single machine with minimial prerequisites. ## Setup -### User Mode -User mode runs the orchestrator from a "binary" single-file release and does not require special Python environment setup. Use this mode unless you plan to make changes to the orchestrator source code. -#### Prerequisites +### Prerequisites Stack Orchestrator is a Python3 CLI tool that runs on any OS with Python3 and Docker. Tested on: Ubuntu 20/22. Ensure that the following are already installed: @@ -30,7 +28,13 @@ Ensure that the following are already installed: # see https://docs.docker.com/compose/install/linux/#install-the-plugin-manually for further details # or to install for all users. ``` -#### Install + +### User Mode Install + +User mode runs the orchestrator from a "binary" single-file release and does not require special Python environment setup. Use this mode unless you plan to make changes to the orchestrator source code. + +*NOTE: User Mode is currently broken, use "Developer mode" described below for now.* + 1. Download the latest release from [this page](https://github.com/cerc-io/stack-orchestrator/tags), into a suitable directory (e.g. `~/bin`): ``` $ cd ~/bin @@ -56,7 +60,7 @@ Ensure that the following are already installed: deploy-system deploy a stack setup-repositories git clone the set of repositories required to build... ``` -### Developer mode +### Developer mode Install Suitable for developers either modifying or debugging the orchestrator Python code: #### Prerequisites In addition to the binary install prerequisites listed above, the following are required: