Skip to content

Commit

Permalink
README: Put installation instructions in own file
Browse files Browse the repository at this point in the history
  • Loading branch information
sils committed Feb 3, 2015
1 parent 3c0abbe commit 25d3d80
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 18 deletions.
34 changes: 34 additions & 0 deletions INSTALL.md
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.
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -34,31 +41,15 @@ https://github.com/coala-analyzer/coala

Authors
-------
Lasse Schuirmann <lasse@schuirmann.net> and Fabian Neuschmidt <fabian@neuschmidt.de> are the current maintainers of this project.
Lasse Schuirmann <lasse@schuirmann.net> and Fabian Neuschmidt
<fabian@neuschmidt.de> are the current maintainers of this project.

Build status
------------
[![Build Status](https://travis-ci.org/coala-analyzer/coala.svg?branch=master)](https://travis-ci.org/coala-analyzer/coala)
[![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
Expand Down

0 comments on commit 25d3d80

Please sign in to comment.