From 25d3d80e5ea825bbe2ccd1a493917cc11b53da7b Mon Sep 17 00:00:00 2001 From: Lasse Schuirmann Date: Tue, 3 Feb 2015 15:09:43 +0100 Subject: [PATCH] README: Put installation instructions in own file --- INSTALL.md | 34 ++++++++++++++++++++++++++++++++++ README.md | 27 +++++++++------------------ 2 files changed, 43 insertions(+), 18 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000000..91b3378003 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,34 @@ +coala Installation +================== + +This document contains information on how to install coala and its dependencies. +Optional dependencies are marked with (*). + +Dependencies +------------ + +### Python +coala requires an installation of Python3 >= 3.2 from http://www.python.org. +coala is fully tested against python versions 3.2, 3.3 and 3.4. + +### espeak (*) +If you want to use coalas voice outputter you need to install espeak from +http://espeak.sourceforge.net/. Note that voice output is currently only +possible when developing for coala. If you care for voice output, please contact +us so we will speed up development of our voice output module. + +coala +----- +coala can be installed afterwards by executing the file setup.py through +the python interpreter (root access necessary): + +```python3 setup.py install``` + +You will have coala installed into your python scripts directory. On an unixoid +system it is probably already available on your command line globally. + +### Alternate installation + +If you want to install coala to an alternate location you can e.g. call +`python3 setup.py install --prefix=/your/prefix/location`. Other options are +documented on https://docs.python.org/3.2/install/#alternate-installation. diff --git a/README.md b/README.md index 305d859afd..6b18d8573d 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,13 @@ README ooP""Y8888PP*"Y8888P" "Y8888P"`Y88P'"Y88P"Y8888P"`Y8 oooo888P" ``` +INSTALLATION +============ + +coala can be installed with `python3 setup.py install`. If you need more +information about the installation and dependencies, take a look at our +INSTALL.md. + ABOUT ===== coala is a simple COde AnaLysis Application. Its goal is to make static code @@ -34,7 +41,8 @@ https://github.com/coala-analyzer/coala Authors ------- -Lasse Schuirmann and Fabian Neuschmidt are the current maintainers of this project. +Lasse Schuirmann and Fabian Neuschmidt + are the current maintainers of this project. Build status ------------ @@ -42,23 +50,6 @@ Build status [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/coala-analyzer/coala/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/coala-analyzer/coala/?branch=master) [![Coverage Status](https://coveralls.io/repos/coala-analyzer/coala/badge.svg)](https://coveralls.io/r/coala-analyzer/coala) -INSTALLATION -============ -Python ------- -coala requires an installation of Python3 >= 3.2 from http://www.python.org. -coala is fully tested against python versions 3.2, 3.3 and 3.4. - -coala ------ -coala can be installed afterwards by executing the file setup.py through -the python interpreter (root access necessary): - -```python3 setup.py install``` - -You will have coala installed into your python scripts directory. On a unix -system it is probably already available on your command line globally. - FUNCTION REFERENCE ================== Try executing `coala -h` for information about the most common settings. You