diff --git a/README.md b/README.md index e857e1cf5..ce7722f2d 100644 --- a/README.md +++ b/README.md @@ -88,6 +88,9 @@ We love the open source software community. Contributing is our passion and beca Please refer to the [Contributing Guide](./CONTRIBUTING.md) +## Development ## + +Most of the main operations can be done through the helper script `manage.sh`. ## License ## diff --git a/manage.sh b/manage.sh index 110f4ef73..e7580f9b7 100755 --- a/manage.sh +++ b/manage.sh @@ -106,6 +106,14 @@ function run_release { function usage { echo "UXBOX build & release manager v$REV" echo "USAGE: $0 [ clean | build | run | test | release-local | release-docker | run-release ]" + echo "Options:" + echo "- clean Stop and clean up docker containers" + echo "- build Build docker container for development with tmux" + echo "- run Run (and build if necessary) development container (frontend at localhost:3449, backend at localhost:6060)" + echo "- test Execute frontend unit tests (backend unit tests no available yet)" + echo "- release-local Build a 'production ready' release" + echo "- release-docker Build a 'production ready' docker container" + echo "- run-release Run a 'production ready' docker-compose environment (frontend at localhost:80, backend at localhost:6060)" } case $1 in