-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Put installation instructions in own file
- Loading branch information
Showing
2 changed files
with
43 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters