From ece33a2d666f26025219ec5059e7a9b0f93b7d31 Mon Sep 17 00:00:00 2001 From: Hannah Wolfe Date: Tue, 12 Nov 2013 08:52:44 +0000 Subject: [PATCH] Clarifying getting started instructions --- README.md | 65 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 41 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 4ace4e930c..49281e6f12 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,40 @@ Ghost is a free, open, simple blogging platform that's available to anyone who w Visit the project's website at ! +Full documentation is available at . + ## Getting Started -There are **two** ways to get started with Ghost: +There are **two** main ways to get started with Ghost, take care to use the method which best suits your needs. -1. **Install from a Release** - these are pre-built zip packages found on [Ghost.org](http://ghost.org/download) which have no dependencies other than node & npm. Installation instructions are below. -2. **Cloning from the GitHub repo** - requires you to build assets yourself. Instructions can be found in [CONTRIBUTING.md](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md) +**Please note** - the downloadable zip files we provide on [Ghost.org](http://ghost.org/download) are pre-built packages designed for getting started quickly. Cloning from the git repository requires you to install several dependencies and build the assets yourself. + +### Getting Started Guide 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 for various platforms visit the [Ghost Installation Guide](http://docs.ghost.org/installation/). If you get stuck, help is available on [our forum](http://ghost.org/forum/). + +1. Install [Node.js](http://nodejs.org) - Ghost requires **Node v0.10.*** +1. Download the latest Ghost package from [Ghost.org](http://ghost.org/download). + **If you cloned the GitHub repository you should follow the instructions [for developers](https://github.com/TryGhost/Ghost#getting-started-guide-for-developers).** +1. Create a new directory where you would like to run the code, and unzip the package to that location. +1. Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.example.js and index.js are) +1. run `npm install --production` to install the node dependencies. If you see `error Error: ENOENT` on this step, make sure you are in the project directory and try again. +1. To start ghost, run `npm start` +1. Visit `http://localhost:2368/` in your web browser or go to `http://localhost:2368/ghost` to log in + +Check out the [Documentation](http://docs.ghost.org/) for more detailed instructions, or get in touch via the [forum](http://ghost.org/forum) if you get stuck. -### Installing from a Release -*Please Note:* Releases are pre-built packages, GitHub releases (tags) are not. To install from GitHub you need to follow the [contributing guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). +### Getting Started Guide for Developers -1. Once you've downloaded one of the releases, unzip it, and place the directory wherever you would like to run the code -2. Fire up a terminal (or node command prompt in Windows) and change directory to the root of the Ghost application (where config.example.js and index.js are) -4. run `npm install --production` to install the node dependencies. If you see `error Error: ENOENT` on this step, make sure you are in the project directory and try again. -4. To start ghost, run `npm start` -5. Visit `http://localhost:2368/` in your web browser or go to `http://localhost:2368/ghost` to log in +If you're a theme, app or core developer, or someone comfortable getting up and running from a `git clone`, this method is for you. + +If you clone the GitHub repository, you will need to build a number of assets, such as SASS and JavaScript templates. This requires you to have Ruby and a number of other pre-requisites. +Full instructions can be found in the [Contributing Guide](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md) under the heading "[Working on Ghost Core](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md#working-on-ghost-core)". Check out the [Documentation](http://docs.ghost.org/) for more detailed instructions, or get in touch via the [forum](http://ghost.org/forum) if you get stuck. @@ -40,6 +56,21 @@ Once you have the Ghost server up and running, you should be able to navigate to Note - this is still very alpha. Not everything works yet. +## Getting Involved + +Want to report a bug, request a feature, or help us build or translate Ghost? Check out our in depth guide to [Contributing to Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). We need all the help we can get! + + +## Community + +Keep track of Ghost development and Ghost community activity. + +* Follow Ghost on [Twitter](http://twitter.com/TryGhost), [Facebook](http://facebook.com/tryghostapp) and [Google+](https://plus.google.com/114465948129362706086). +* Read and subscribe to the [The Official Ghost Blog](http://blog.ghost.org). +* Join in discussions on the [Ghost Forum](http://ghost.org/forum/) +* Chat with Ghost developers on IRC. We're on `irc.freenode.net`, in the `#Ghost` channel. + + ## Versioning For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Ghost will be maintained according to the [Semantic Versioning](http://semver.org/) guidelines as much as possible. @@ -56,20 +87,6 @@ Constructed with the following guidelines: * A new *build* release indicates this is a pre-release of the version. -## Reporting Bugs and Contributing Code - -Want to report a bug, request a feature, or help us build Ghost? Check out our in depth guide to [Contributing to Ghost](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md). We need all the help we can get! - - -## Community - -Keep track of Ghost development and Ghost community activity. - -* Follow Ghost on [Twitter](http://twitter.com/TryGhost), [Facebook](http://facebook.com/tryghostapp) and [Google+](https://plus.google.com/114465948129362706086). -* Read and subscribe to the [The Official Ghost Blog](http://blog.ghost.org). -* Chat with Ghost developers on IRC. We're on `irc.freenode.net`, in the `#Ghost` channel. - - ## Copyright & License Copyright (C) 2013 The Ghost Foundation - Released under the MIT License.