From 03748361ffc39048f97632f9802b9890d928e2ea Mon Sep 17 00:00:00 2001 From: Joe Bellus Date: Thu, 29 Sep 2022 12:34:45 -0400 Subject: [PATCH] Added readme --- README.org | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.org diff --git a/README.org b/README.org new file mode 100644 index 0000000..447551f --- /dev/null +++ b/README.org @@ -0,0 +1,26 @@ + +See the homepage: https://conductor.5sigma.io + +* Usecase + +Conductor is built to serve as a development stack launcher and task manager. It is useful when a development stack contains several parts. For instance: A frontend development web server, a backend api server, and supporting services. These can all be launched at once and their outputs aggrigated. + +Conductor also has a robust tasking system allowing utility tasks to be defined and run. This is useful for build or setup operations related to development. Such as: Database migrations, local builds, testing across the entire stack, etc. + +* Platforms + +A Conductor binary is provided for 64 bit linux based systems. + +* Getting started + +1. Download the conductor binary + #+begin_src sh + curl https://objects.5sigma.io/public/conductor.tar.gz | tar -xz + #+end_src + +2. (/Optional/) place this binary somewhere in your path. +3. Setup a conductor.yml in the root of your project. See http://conductor.5sigma.io/articles/config/ for the yaml file specifications. +4. Launch tasks + #+begin_src sh +conductor taskname + #+end_src