Possible README installation instruction #8175
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ErisDS
reviewed
Mar 16, 2017
JohnONolan
approved these changes
Mar 16, 2017
- add contributing workflow link already - i would suggest we merge this PR if the workflow guide was reviewed
|
How come this is still WIP? Would like to merge 😁 |
|
I played with the markdown formatting a bit, because i couldn't use colours in github markdown. I will update later and then we can merge. |
|
Pushed some final updates. I have removed the information about the fork url. I think people should follow our git workflow and add their fork as remote stream. The git workflow is also linked in our working with ghost wiki. Tell me if you feel different. |
kirrg001
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The installation steps in the README are not optimal right now.
I went over them and found some variants.
^ very short,
npm run initwraps all necessary commands to install Ghost.^ we show people that they have to run
knex-migrator init^ we describe all commands
No matter which variant we take, i would like to create a wiki page to have some more detailed descriptions for installation, workflow, testing (e.g. how can a user reset it's database, how can a use run a single test etc). So the README could link to a wiki page with a full guide.
One thing to note
To be able to run
grunt init, we have to install the Ghost dependencies.This was tested with a fresh clone and zero global or local npm packages.