Skip to content

Commit

Permalink
Tidied INSTALL file. [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Mar 23, 2017
1 parent 446d47a commit d262fa9
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,19 @@
**See [The Cylc User Guide](https://cylc.github.io/cylc/documentation.html) for
detailed instructions.**

Note: *to run distributed suites Cylc must be installed on task hosts as well
as suite hosts.*
* Cylc must be installed on task job hosts as well as suite hosts.*

### External Software Packages.
### Required External Software Packages

Several external packages required on suite hosts are not needed on task hosts:
*graphviz*, and *pygraphviz*. These should only need to be installed
once, and then updated infrequently.
These are not required on job hosts. These can be installed once and updated
infrequently.

* graphviz
* pygraphviz

### Installing Cylc

Download the latest release tarball from https://github.com/cylc/cylc/releases.
Download the latest tarball from https://github.com/cylc/cylc/releases.

```bash
cd /home/admin/cylc/
Expand All @@ -38,8 +39,10 @@ cp admin/cylc-wrapper /usr/local/bin/cylc
```

When you type `make`:
* A file called VERSION is created from the name of the sourc directory.
* The Cylc documentation is generated from source, in doc/install/.
* A file called VERSION is created, containing the Cylc version number
* The version number is taken from the name of the parent directory: DO NOT
CHANGE THE NAME OF THE UNPACKED SOURCE DIRECTORY
* The Cylc documentation is generated from source and put in doc/install/

### Installing The Documentation

Expand Down

0 comments on commit d262fa9

Please sign in to comment.