Merge pull request #368 from JrGoodle/refactor

Refactor ClowderController

CONTRIBUTING.md

@@ -12,7 +12,7 @@ $ cd clowder
 Add the directory you cloned the repo into to `PYTHONPATH` in your shell profile. For example, if cloned into `$HOME/clowder`
 
 ```bash
-export PYTHONPATH=$PYTHONPATH:$HOME/clowder
+export PYTHONPATH=$PYTHONPATH:$HOME/clowder/clowder
 ```
 
 ## Building
@@ -26,7 +26,7 @@ $ script/update
 Remove `clowder` and clean test directories
 
 ```bash
-$ script/clean
+$ script/clean all
 ```
 
 ## Testing
@@ -45,31 +45,6 @@ $ clowder-test cats herd
 $ clowder-test unittests
 ```
 
-## More info
-
-### Commands
-
-See the [clowder commands doc](docs/commands.md)
-for documentation of all command options
-
-For example output from individual commands see the [clowder command examples](docs#commands)
-
-### The `clowder.yaml` file
-
-See the [clowder.yaml doc](docs/clowder-yaml.md)
-for an explanation of the `clowder.yaml` configuration file
-
-### The clowder repo
-
-See the [clowder repo doc](docs/clowder-repo.md)
-for a description of the structure of the clowder repo cloned in the `.clowder` directory
-
-
-### Using `clowder` with forks
-
-See the [forks doc](docs/forks.md)
-for a description of the behavior of `clowder` commands with forks
-
 ## Pull requests
 
 Any new functionality or bug fixes must have associated tests, in order to prevent future regressions. There are a few Python unit tests, but the majority of the tests are located in bash scripts in [test/scripts](test/scripts)

README.md

@@ -28,48 +28,18 @@ All of these have their own approach, but many are based on submodules or subtre
 
 The primary purpose of `clowder` is synchronization of multiple repositories, so normal development still takes place in individual repositories with the usual `git` commands
 
-# Getting Started
-
-## Requirements
-
-- [git](https://git-scm.com)
-- [Python 3](https://www.python.org/downloads/)
-
-### macOS
-
-macOS comes with `git` preinstalled. To install Python 3 with [Homebrew](https://brew.sh)
-
-```bash
-$ brew install python3
-```
-
-### Ubuntu 16.04
-
-```bash
-$ sudo apt install git
-$ sudo apt install python3-pip
-```
-
-### Windows
-
-Currently `clowder` has only been tested on Windows with [Cygwin](https://cygwin.com/install.html). The following dependencies should be installed
-
-- git
-- python3-pip
-- python3
-
-## Installation
+# Installation
 
 To install `clowder` from PyPI
 
 ```bash
-$ sudo pip3 install clowder-repo
+$ sudo pip install clowder-repo
 ```
 
 To upgrade to the latest version
 
 ```bash
-$ sudo pip3 install clowder-repo --upgrade
+$ sudo pip install clowder-repo --upgrade
 ```
 
 For terminal autocompletion add the following line to your bash profile
@@ -164,6 +134,6 @@ for a description of the structure of the clowder repo cloned in the `.clowder`
 See the [forks doc](https://github.com/JrGoodle/clowder/blob/master/docs/forks.md)
 for a description of the behavior of `clowder` commands with forks
 
-## Development
+# Development
 
 See [CONTRIBUTING.md](https://github.com/JrGoodle/clowder/blob/master/CONTRIBUTING.md) for information on setting up your environment for development and for contribution guidelines