Skip to content

Commit

Permalink
README & CONTRIBUTING updates
Browse files Browse the repository at this point in the history 
- update compatibility info
- better information on releases
- add ideas.ghost.org to feature request section of contrib
  • Loading branch information
@ErisDS
ErisDS committed Mar 9, 2015
1 parent 45010c9 commit 338e52f
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 28 deletions.
18 changes: 11 additions & 7 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,18 +105,22 @@ reported. Especially, why do you consider this to be a bug? What do you expect t
<a name="features"></a>
### Feature Requests

Feature requests are very welcome, and you can also suggest roadmap additions via [the forum](https://ghost.org/forum/bugs-suggestions/17479-ghost-roadmap-got-a-great-idea/). Before you make your suggestion, please:
If you've got a great idea, we want to hear about it. Our [user wishlist](http://ideas.ghost.org) exists so that we can learn more about what our community wants us to build.

1. Visit the [Roadmap](https://github.com/TryGhost/Ghost/wiki/Roadmap) & **use the GitHub search** to
Please use your discretion to decide whether a feature request belongs on the [wishlist](http://ideas.ghost.org) or whether it's better suited to a GitHub issue.

Before making a suggestion, here are a few handy tips on what to consider:

1. Visit the [Roadmap](https://github.com/TryGhost/Ghost/wiki/Roadmap), [wishlist](http://ideas.ghost.org) & **use the GitHub search** to
see if the feature has already been requested

2. Have a quick read through [What makes it into Ghost core?](https://github.com/TryGhost/Ghost/wiki/What-makes-it-into-Ghost-core%3F) and decide whether your idea fits with the scope and aims of the project
2. Check out [What makes it into Ghost core?](https://github.com/TryGhost/Ghost/wiki/What-makes-it-into-Ghost-core%3F) - this explains the guidelines for what fits into the scope and aims of the project

3. Remember, it's up to *you* to make a strong case to convince the project's leaders of the merits of this
feature. Please provide as much detail and context as possible, this means explaining the use case and why it is
likely to be common.
3. Have a quick think about whether your feature is for the admin UI, the blog output, themes or apps - or does it affect multiple areas? This can help when describing your idea.

4. Clearly indicate whether this is a feature request for Ghost admin, or for themes or apps.
4. Remember, it's up to *you* to make a strong case to convince the project's leaders of the merits of a new
feature. Please provide as much detail and context as possible, this means explaining the use case and why it is
likely to be common. The strongest vote in favour of any feature request is hands-down, un-debatable traction on our user wishlist.


<a name="changes"></a>
Expand Down
32 changes: 11 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,20 @@ There are a few different ways to install Ghost, take care to use the method whi

### Compatibility

Ghost is currently compatible with **Node v0.10.x** only.
Ghost is fully compatible with **Node v0.10.x**, 0.10.36 is the recommended version of Node for running Ghost in production.

Ghost is also compatible with **Node v0.12** and **io.js-v1.2**. Please note that these versions are more likely to run into installation problems, please use the [support forum](https://ghost.org/forum/installation/) for help with install issues.

Ghost may also be compatible with other io.js versions, providing binaries are available for sqlite3, and for node-sass if you are building Ghost from source rather than using a pre-built zip file.

Support for [v0.12.x](https://github.com/TryGhost/Ghost/issues/4240) and [io.js](https://github.com/TryGhost/Ghost/issues/4811) is a work in progress (click the versions for more info on each).

### Install from zip (fastest & best for bloggers)

If you just want to get a Ghost blog running in the fastest time possible, this method is for you.

For detailed instructions on various platforms, visit the [Ghost Installation Guide](http://support.ghost.org/installation/). If you get stuck, help is available on [our support site](http://support.ghost.org/).

1. Install [Node.js](http://nodejs.org) - Ghost requires **Node v0.10.x**
1. Install [Node.js](http://nodejs.org) - See [compatibility](https://github.com/TryGhost/Ghost#compatibility) section for details of supported versions
1. Download the latest Ghost package from [Ghost.org](http://ghost.org/download).
1. Create a new directory where you would like to run the code, and un-zip the package to that location.
1. Fire up a Terminal, the Node Command Prompt or shell and change directory to the root of the Ghost application (where config.example.js and index.js are)
Expand All @@ -53,6 +56,7 @@ Full instructions & troubleshooting tips can be found in the [Contributing Guide

#### Quickstart:

1. Install node (see [compatibility](https://github.com/TryGhost/Ghost#compatibility) section for details of supported versions)
1. `npm install -g grunt-cli`
1. `npm install`
1. `grunt init` (and `grunt prod` if you want to run Ghost in production mode)
Expand All @@ -70,9 +74,11 @@ If you want to build Ghost into a larger node app, or are familiar with using `n
Further setup instructions can be found in the [using Ghost as an npm module](https://github.com/TryGhost/Ghost/wiki/Using-Ghost-as-an-npm-module) wiki entry.


### Upgrading to The Latest Version
### Keeping up-to-date

Upgrade instructions can be found on the [Ghost Support Site](http://support.ghost.org/how-to-upgrade/).

Upgrade instructions can be found on the [Ghost Support Site](http://support.ghost.org/how-to-upgrade/)
New releases are announced on the [dev blog](http://dev.ghost.org/tag/releases/), which you can subscribe to for notifications of new versions. Each new release is published with highlights and a full changelog, which are also available on the [releases page](https://github.com/TryGhost/Ghost/releases) of GitHub.


### Logging in For The First Time
Expand All @@ -90,22 +96,6 @@ Keep track of Ghost development and Ghost community activity.
* Chat with Ghost developers on IRC. We're on `irc.freenode.net`, in the `#Ghost` channel. We have a public meeting every Tuesday at 5:30pm London time.


## Versioning

For transparency and insight into our release cycle, along with striving to maintain backward compatibility, Ghost will be maintained according to the [Semantic Versioning](http://semver.org/) guidelines as much as possible.

Releases will be numbered with the following format:

`<major>.<minor>.<patch>-<build>`

Constructed with the following guidelines:

* A new *major* release indicates a large change where backwards compatibility is broken.
* A new *minor* release indicates a normal change that maintains backwards compatibility.
* A new *patch* release indicates a bugfix or small change which does not affect compatibility.
* A new *build* release indicates this is a pre-release of the version.


## Copyright & License

Copyright (c) 2013-2015 Ghost Foundation - Released under the [MIT license](LICENSE).

0 comments on commit 338e52f

Please # to comment.