Skip to content

Commit

Permalink
Tweak README.md etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Jul 17, 2018
1 parent a3b3f61 commit d0b6f26
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 36 deletions.
45 changes: 24 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Report Bugs

Report bugs by opening an issue on the [Cylc repository @
Github](https://github.com/cylc/cylc/issues). Give your Cylc version number and
a recipe to reproduce the bug.
Report bugs by opening an issue at [Cylc Issues on
Github](https://github.com/cylc/cylc/issues). Give the Cylc version that
suffers from the bug, and a recipe to reproduce the problem.

## Request Enhancements

Request enhancements by opening an issue on the [Cylc repository @
Request enhancements by opening an issue at [Cylc Issues @
Github](https://github.com/cylc/cylc/issues). Describe the use case in detail.

## Contribute Code
Expand All @@ -24,8 +24,11 @@ name is listed in this file before merging the pull request into *master*.

The following people have contributed to this code under the terms of
the Contributor Licence Agreement and Certificate of Origin detailed
below. (NOTE: those in _italics_ predate the introduction of this agreement;
they will be contacted for consent).
below.

_NOTE: the names _(parenthesised)_ below represent contributions from outside of
NIWA and Met Office that predate the introduction of this Agreement (July
2018). These developers will be contacted to seek their consent._

- Hilary Oliver
- Matt Shin
Expand All @@ -34,27 +37,27 @@ they will be contacted for consent).
- Oliver Sanders
- Declan Valters
- Sadie Bartholomew
- _Luis Kornblueh_
- (Luis Kornblueh)
- Kerry Day
- Prasanna Challuri
- David Matthews
- _Tim Whitcomb_
- _Scott Wales_
- (Tim Whitcomb)
- (Scott Wales)
- Tomek Trzeciak
- _Thomas Coleman_
- (Thomas Coleman)
- Bruno Kinoshita
- _Annette Osprey_
- _Jonathan Thomas_
- (Annette Osprey)
- (Jonathan Thomas)
- Rosalyn Hatcher
- _Domingo Manubens Gil_
- (Domingo Manubens Gil)
- Jonny Williams
- _Milton Woods_
- _Alex Reinecke_
- _Chan Wilson_
- _Kevin Pulo_
- (Milton Woods)
- (Alex Reinecke)
- (Chan Wilson)
- (Kevin Pulo)
- Lois Hugget
- _Martin Dix_
- _Ivor Blockley_
- (Martin Dix)
- (Ivor Blockley)

(All contributors are identifiable with email addresses in the git version
control logs or otherwise.)
Expand Down Expand Up @@ -99,5 +102,5 @@ By making a contribution to this project, I certify that:
I become aware.

(The Cylc Contributor Licence Agreement and Certificate of Origin is
inspired by the Certificate of Origin used by Enyo and the Linux
Kernel.)
inspired that of [Rose](https://github.com/metomi/rose), which in turn was
inspired by the Certificate of Origin used by Enyo and the Linux Kernel.)
13 changes: 3 additions & 10 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Cylc Installation.
# Cylc: Quick Installation Guide

**See also [The Cylc User Guide](https://cylc.github.io/cylc/documentation.html).**
**See [The Cylc User Guide](https://cylc.github.io/cylc/documentation.html) for
more detailed information.**

Cylc must be installed on suite and task job hosts. Third-party dependencies
(below) are not required on job hosts.
Expand Down Expand Up @@ -101,11 +102,3 @@ Summary:

After running `make`, copy the `doc/install` directory to a location such as
`/var/www/html/` and update your Cylc site config file to point to it.

### Cloning The Cylc Repository

To participate in Cylc development fork [Cylc on
GitHub](https://github.com/cylc/cylc) and make a local clone of your own fork
to work in. Changes should be developed in feature branches then pushed to
your GitHub fork before issuing a Pull Request to the team. Please post an
Issue to discuss proposed changes before you begin any signficant work.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
[![DOI](https://zenodo.org/badge/1836229.svg)](https://zenodo.org/badge/latestdoi/1836229)

Cylc (“silk”) orchestrates complex distributed suites of interdependent cycling
(or non-cycling) tasks. It was originally designed for environmental
forecasting systems at [NIWA](https://www.niwa.co.nz) (but it is not
specialized to environmental forecasting in any way).
(or non-cycling) tasks. It was originally designed to automate environmental
forecasting systems at [NIWA](https://www.niwa.co.nz). Cylc is a general
workflow engine, however; it is not specialized to forecasting in any way.

[Quick Installation](INSTALL.md) |
[Web Site](https://cylc.github.io/cylc) |
[User Guide and other documentation](https://cylc.github.io/cylc/documentation) |
[How to Contribute](CONTRIBUTING.md)
[Documentation](https://cylc.github.io/cylc/documentation) |
[Contributing](CONTRIBUTING.md)

### Copyright and Terms of Use

Expand Down

0 comments on commit d0b6f26

Please sign in to comment.