From 405973c5510504f9d28d42a28ccc1d4cc9ad9879 Mon Sep 17 00:00:00 2001 From: Francesco Siddi Date: Fri, 5 Dec 2014 14:49:57 +0100 Subject: [PATCH] Client docs --- docs/source/install/index.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst index f43b2d3..d60f6f5 100644 --- a/docs/source/install/index.rst +++ b/docs/source/install/index.rst @@ -15,3 +15,15 @@ In order to get it up and running. - Run the service To learn about the web-service usage, check out the proper (non existing) section. + + +Client +====== + +In order to use the `bam` command in your terminal, you can add this file in any of +your BIN paths and call it `bam`. Don't forget to give it +x permissions. :: + + #!/bin/sh + exec python /absolute/path/to/bam/client/cli/bam.py "$@" + +As you can see, the file links to your bam.py file, so make sure that one is right!