update usage

diff --git a/usage.txt b/usage.txt
index d52ddc1a56461fa3dcf859c324f3655a04003a32..49ed6f14e54ecc2b28d76df5124c6153c29f0bd9 100644 (file)
--- a/usage.txt
+++ b/usage.txt
@@ -16,23 +16,27 @@ installation:
        config options, and default location for project homes
                BCI_HOME="$HOME/.bci"
                mkdir -p "$BCI_HOME"
+       BCI scripts and binaries will install to $BCI_HOME/bin
+       which should be added to your $PATH variable
+
+project creation:
+       the only thing bci requires to create a new project is a location to git clone from
+       additionally, users may specify a project name and project home directory
+       if no name is given, bci will use the name of the git repository
+       if no project home is given, bci will default to $BCI_HOME/projects/<project_name>
+
+       information about all bci projects will be stored in $BCI_HOME/config
 
 project organization:
-       when you create a project, it must have the following:
-               a location to git clone from (required)
-               a project name (optional)
-                       derrivable from the git clone location
-               a project home (optional) ($PROJ_HOME)
-                       by default PROJ_HOME will be $BCI_HOME/projects/<project_name>
-       $PROJ_HOME will contain three directories:
-               $PROJ_HOME/config:
+       $PROJ_HOME will contain three items:
+               $PROJ_HOME/config: (file)
                        this is where all configuration options for bci_proj will live for this specific project
                        including file rotation config options for data (how many builds to keep)
-               $PROJ_HOME/repo:
+               $PROJ_HOME/repo: (directory)
                        this is where the project itself is checked out. when the project is first created,
                        specify a remote location to git clone from
                        run git clone <remote> $PROJ_HOME/repo
-               $PROJ_HOME/data:
+               $PROJ_HOME/data: (directory)
                        this is where bci will store data relate to previous builds of the project
                        this includes error logs, build information, test outputs, etc.