| Message ID | 20180723070431.565-5-andrew.donnellan@au1.ibm.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series | [v2,1/6] CONTRIBUTING.md: Update references, add rustfmt information | expand |
On Mon, 2018-07-23 at 17:04 +1000, Andrew Donnellan wrote: > Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> > --- > README.md | 22 ++++++++++++++++++++++ > 1 file changed, 22 insertions(+) > > diff --git a/README.md b/README.md > index f69402635d4d..d03be5d56bc8 100644 > --- a/README.md > +++ b/README.md > @@ -42,6 +42,18 @@ snowpatch is named in honour of > creation of snowpatch. > > > +Project Status > +-------------- > + > +snowpatch is currently under heavy development. It implements enough > core > +functionality to be useful for basic CI requirements, and is > currently deployed > +in production for a small number of projects. There are many core > features that > +are still yet to be implemented, and documentation is still > incomplete. > + > +At this stage, there are no stability guarantees, and behaviour is > liable to > +change significantly in new versions without notice. It would be good to mention here (in future) examples - i.e. here's patchwork.ozlabs.org with a list snowpatch is testing, this is one of the jobs it's running in Jenkins, etc. > + > + > Installing > ---------- > > @@ -72,6 +84,16 @@ To compile snowpatch manually, clone the git > repository and run `cargo build > executed using `cargo run`. > > > +Documentation > +------------- > + > +For usage information, run `snowpatch --help`. > + > +Example configurations can be found in the [`examples`](examples) > directory. > + > +Additional documentation can be found in the [`docs`](docs) > directory. > + > + > Contributing > ------------ >
diff --git a/README.md b/README.md index f69402635d4d..d03be5d56bc8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,18 @@ snowpatch is named in honour of creation of snowpatch. +Project Status +-------------- + +snowpatch is currently under heavy development. It implements enough core +functionality to be useful for basic CI requirements, and is currently deployed +in production for a small number of projects. There are many core features that +are still yet to be implemented, and documentation is still incomplete. + +At this stage, there are no stability guarantees, and behaviour is liable to +change significantly in new versions without notice. + + Installing ---------- @@ -72,6 +84,16 @@ To compile snowpatch manually, clone the git repository and run `cargo build executed using `cargo run`. +Documentation +------------- + +For usage information, run `snowpatch --help`. + +Example configurations can be found in the [`examples`](examples) directory. + +Additional documentation can be found in the [`docs`](docs) directory. + + Contributing ------------
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com> --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)