From 49cfdc31b22a995933529d0821643ac9c578e06b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89loi=20Rivard?= Date: Fri, 13 Nov 2020 11:15:17 +0100 Subject: [PATCH] Updated README --- README.md | 9 ++++++++- demo/run.sh | 15 +++++++++------ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7fc6989e..41868a00 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,17 @@ It aims to be very light, simple to install and simple to maintain. Its main fea Canaille +# Try it! + +```bash +cd demo +./run.sh +``` + # Documentation ⚠ Canaille is under heavy development and may not fit a production environment yet. ⚠ - Please have a look on our [documentation](https://canaille.readthedocs.io); - To **install** canaille, just follow the [installation guide](https://canaille.readthedocs.io/en/latest/install.html); -- To **contribute** canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/contributing.html). +- To **contribute** to canaille, please read the [contribution guide](https://canaille.readthedocs.io/en/latest/contributing.html). diff --git a/demo/run.sh b/demo/run.sh index 9c821a50..899a8453 100755 --- a/demo/run.sh +++ b/demo/run.sh @@ -1,15 +1,18 @@ #!/bin/bash +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" + if ! type python > /dev/null 2>&1; then echo "Cannot start the LDAP server. Please install python on your system." return -1 fi -if ! test -d env; then - virtualenv env - env/bin/pip install --editable .. - env/bin/pip install honcho requests - env/bin/pip install --upgrade git+https://github.com/python-ldap/python-ldap.git +if ! test -d "$DIR/env"; then + + virtualenv "$DIR/env" + $DIR/env/bin/pip install --editable "$DIR/.." + $DIR/env/bin/pip install honcho requests + $DIR/env/bin/pip install --upgrade git+https://github.com/python-ldap/python-ldap.git fi -env/bin/honcho start +env "PWD=$DIR" $DIR/env/bin/honcho start