TryGhost/Ghost
1
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-13 10:55:58 +03:00
Code Issues Projects Releases Wiki Activity

added readme explanations

Browse Source
This commit is contained in:
Gabor Javorszky 2013-05-25 15:22:53 +01:00
parent b39efd2680
commit 6f87ecc3ee
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -23,7 +23,8 @@ The top priorities right now are:
1. Clone the git repo
1. cd into the project folder and run `npm install`.
* If the install fails with errors to do with "node-gyp rebuild", follow the Sqlite3 install instructions
1. cd into /core/admin/assets and run `compass compile --css-dir=css`
* Usually if you're within vagrant, and have installed the guest plugins and updated that, this will not happen
1. run `grunt init` from the root. (make sure you have Casper 1.1 installed though, or have installed `bourbon` on your vagrant. See Ghost-Vagrant for that)
Frontend can be located at [localhost:3333](localhost:3333), Admin is at [localhost:3333/ghost](localhost:3333/ghost)
@ -56,7 +57,7 @@ If you have a bug or feature request, please [open a new issue](https://github.c
## Contributions
Pleas submit pull requests in order to contribute back to Ghost - referencing any relevant or open issues in the bug tracker.
Pleas submit pull requests in order to contribute back to Ghost - referencing any relevant or open issues in the bug tracker.
All code should conform, strictly, to the Ghost project [Code Standards](https://github.com/TryGhost/Ghost/wiki/Code-standards).
@ -74,10 +75,19 @@ Keep track of Ghost development and Ghost community activity.
A SASS compiler is required to work with the CSS in this project.
Run `compass compile --css-dir=css` from /core/admin/assets.
With bourbon, all you have to do is run `grunt init` from the root of Ghost, which will compile the admin section. For everything else, use `sass <sourcefile> <targetfile>`.
We also recommend [CodeKit](http://incident57.com/codekit/) (Paid/Mac) & [Scout](http://mhs.github.io/scout-app/) (Free/Mac/PC).
## Changelog
### 0.1.1
* Added bourbon awesomeness, and various fixes as per commit history.
* Started writing changelogs
* Removed compass dependencies, and made grunt work again. See Installation section.
## Copyright & License
Copyright (C) 2013 Ghost