tqt
/
Ghost
mirror of https://github.com/TryGhost/Ghost.git
2
1
Fork 0
Code Issues 1 Releases Wiki Activity

README and CONTRIBUTING docs updates 

- removed note about ssh
- added links to docs and forum
- added note about grunt prod
- more troubleshooting tips
This commit is contained in:
Hannah Wolfe 2013-10-16 15:55:23 +01:00
parent 75ba76c25a
commit 2dfadcbbcd
2 changed files with 19 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -26,7 +26,7 @@ If you think you've found a problem with Ghost, or you'd like to make a request
### Installation / Setup Instructions
1. Clone the git repo via SSH, not HTTP - we use SSH submodules
1. Clone the git repo
2. cd into the project folder
3. Run `git submodule update --init`
4. Run `npm install -g grunt-cli`
@ -38,7 +38,7 @@ If you think you've found a problem with Ghost, or you'd like to make a request
Front-end can be located at [localhost:2368](http://localhost:2368), Admin is at [localhost:2368/ghost/](http://localhost:2368/ghost/)
Whist developing you may wish to use **grunt watch** to watch for changes to handlebars and sass and recompile automatically, see the [Grunt Toolkit docs](https://github.com/TryGhost/Ghost/wiki/Grunt-Toolkit).
Whist developing you may wish to use **grunt watch** to watch for changes to handlebars and sass and recompile automatically, if you run Ghost in **production** mode, you will need to run **grunt prod** - please see the [Grunt Toolkit docs](https://github.com/TryGhost/Ghost/wiki/Grunt-Toolkit).
### Updating with the latest changes
@ -56,16 +56,10 @@ Pulling down the latest changes from master will often require more than just a
- **[releases](https://github.com/TryGhost/Ghost/releases)** are used to contain stable tagged versions of Ghost.
### SQLite3 Install Instructions
*Only needed if you experienced errors in Step 5 above - Skip this otherwise*
Ghost depends upon SQLite3, which requires a native binary. These are provided for most major platforms, but if you are using a more obscure *nix flavor you may need to follow the [node-sqlite3 binary instructions](https://github.com/developmentseed/node-sqlite3/wiki/Binaries).
### Compiling CSS & JavaScript
A SASS compiler is required to work with the CSS in this project. You can either do this by running `grunt` from the command line - or by using a 3rd party app. We recommend [CodeKit](http://incident57.com/codekit/) (Paid/Mac) & [Scout](http://mhs.github.io/scout-app/) (Free/Mac/PC).
You will need to have Ruby installed, as well as having run `gem install sass && gem install bourbon`.
## Coding standards
@ -140,6 +134,15 @@ Sounds like you don't have our default theme - Casper, your content/themes/caspe
Sounds like you don't have the Ruby gem "bourbon" installed. Make sure you have Ruby, and then run `gem install bourbon`.
### Ghost doesn't do anything - I get a blank screen
Sounds like you probably didn't run the right grunt command for building assets
### SQLite3 doesn't install properly during npm install
Ghost depends upon SQLite3, which requires a native binary. These are provided for most major platforms, but if you are using a more obscure *nix flavor you may need to follow the [node-sqlite3 binary instructions](https://github.com/developmentseed/node-sqlite3/wiki/Binaries).
## Contributor License Agreement
By contributing your code to Ghost you grant the Ghost Foundation a non-exclusive, irrevocable, worldwide, royalty-free, sublicenseable, transferable license under all of Your relevant intellectual property rights (including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation: (a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. Except for the licenses granted herein, You reserve all right, title, and interest in and to the Contribution.

20
README.md
View File

@ -7,10 +7,11 @@ Visit the project's website at [http://ghost.org](http://ghost.org)!
## Getting Started
There are two main ways to get started with Ghost:
There are **two** ways to get started with Ghost:
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)
1. Working from a Release - these are pre-built zip packages found on ghost.org. Installation instructions are below.
2. Working from the GitHub repo - instructions can be found in [CONTRIBUTING.md](https://github.com/TryGhost/Ghost/blob/master/CONTRIBUTING.md)
### Installing from a Release
@ -20,20 +21,13 @@ There are two main ways to get started with Ghost:
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
4. To start ghost, run `npm start`
5. Visit `http://localhost:2368/` in your web browser
5. 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.
### Updating with the latest changes
**Warning:** The Ghost file system contains your database and config. Be sure to back these up first.
1. Make a backup of your data!
2. Update the files by pasting new files over the top of old ones. If prompted by your OS or FTP client to 'merge' or 'replace' always choose 'merge'.
3. Run npm install
4. Run npm update
5. Restart the application
6. Log out and log back in again.
Documentation on updating can be found in the [Ghost Guide](http://docs.ghost.org/installation/upgrading/)
### Logging in For The First Time