Added readme
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/pr Build is passing Details

This commit is contained in:
Joe Bellus 2022-09-29 12:34:45 -04:00
parent eaca3f2d4b
commit 03748361ff
1 changed files with 26 additions and 0 deletions

26
README.org Normal file
View File

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