diff --git a/README.md b/README.md index 562a0caf..f219d122 100644 --- a/README.md +++ b/README.md @@ -8,18 +8,10 @@ and released under the [GNU Affero General Public License V3](http://www.gnu.org Its website can be found at [octoprint.org](http://octoprint.org). -Reporting bugs --------------- +Contributing +------------ -OctoPrint's issue tracker can be found [on Github](https://github.com/foosel/OctoPrint/issues). **Before opening a new -ticket please take a look at [this guide on how to file a bug report with OctoPrint](https://github.com/foosel/OctoPrint/wiki/How-to-file-a-bug-report).** - -Sending pull requests ---------------------- - -Please create all pull requests against the [devel branch](https://github.com/foosel/OctoPrint/tree/devel) of OctoPrint, as that one is used for developing new -features and then merged against master when those features are deemed mature enough for general consumption. In case -of bug fixes I'll take care to cherry pick them against master if the bugs they are fixing are critical. +Please see the project's [Contribution Guidelines](https://github.com/foosel/OctoPrint/blob/master/CONTRIBUTING.md). Installation ------------ @@ -32,10 +24,10 @@ which is a custom SD card image that includes OctoPrint plus dependencies. Dependencies ------------ -OctoPrint depends on a couple of python modules to do its job. Those are listed in requirements.txt and can be -installed using `pip`: +OctoPrint depends on a couple of python modules to do its job. Those are automatically installed when installing +OctoPrint via `setup.py`: - pip install -r requirements.txt + python setup.py install You should also do this after pulling from the repository, since the dependencies might have changed. @@ -44,7 +36,7 @@ OctoPrint currently only supports Python 2.7. Usage ----- -Just start the server via +From the source directory you can start the server via ./run @@ -70,6 +62,11 @@ e.g.: See `run --help` for further information. +Running the `setup.py` script also installs the `octoprint` startup script in your Python installation's scripts folder +(which depending on whether you installed OctoPrint globally or into a virtual env will be on your `PATH` or not). The +examples above also work with that startup script as it excepts the same parameters as `run`. + + Configuration ------------- @@ -79,8 +76,3 @@ at `~/Library/Application Support/OctoPrint` on MacOS. A comprehensive overview of all available configuration settings can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki/Configuration). - -Setup on a Raspberry Pi running Raspbian ----------------------------------------- - -A comprehensive setup guide can be found [on the wiki](https://github.com/foosel/OctoPrint/wiki/Setup-on-a-Raspberry-Pi-running-Raspbian).