Standard Readme #8
Conversation
this is not supposed to be installed locally, so shouldn't be here
|
|
||
| A Yeoman generator for Flynt components. | ||
| > A Yeoman generator for Flynt |
There was a problem hiding this comment.
How about
A Yeoman generator for the Flynt Framework.
There was a problem hiding this comment.
We discussed this and left out framework because Flynt is not listed anywhere as the Flynt Framework right? And framework would have to be lowercase, which looks weird.
There was a problem hiding this comment.
True, seems like we are a little inconsistent at the moment actually and sometimes refer to it as 'the Flynt framework' - like in the CLI and the core repo descriptions.
|
|
||
| ## Install | ||
|
|
||
| The used node version should be `^6`. If you use a node version manager (e.g. [nave](https://github.com/isaacs/nave)), use `npm` to install globally: |
There was a problem hiding this comment.
The node version used with this generator
There was a problem hiding this comment.
Copied from flynt-cli. I think it's obvious it's for the generator since you are reading the install instructions for the generator...
There was a problem hiding this comment.
OK, but the word order just needs flipping around because that sounds weird in english.
The node version used not the used node version
| The used node version should be `^6`. If you use a node version manager (e.g. [nave](https://github.com/isaacs/nave)), use `npm` to install globally: | ||
|
|
||
| ```bash | ||
| $ npm i -g @flyntwp/generator-flynt |
There was a problem hiding this comment.
Do we add the $ now? We don't do this in the main flynt docs, just wondering if we should?
There was a problem hiding this comment.
Copied from flynt-cli. No idea, but I have seen this in many readmes and docs.
|
|
||
| This project is maintained by [bleech](https://bleech.de). | ||
|
|
||
| Main people in charge of the repo are: |
There was a problem hiding this comment.
The main people in charge of this repo are:
There was a problem hiding this comment.
Could change it.. this needs to be adjusted in all flynt readmes then.
| To contribute, please use github [issues](https://github.com/flyntwp/generator-flynt/issues). If you are a developer and would like to submit a pull request, do the following: | ||
|
|
||
| 1. Fork the project and clone it. | ||
| 2. Run npm install inside the cloned folder. |
There was a problem hiding this comment.
Run npm install (missing backquotes)
|
|
||
| If you want to check or uncheck a file for the generator make sure to use **space** to check/uncheck your selection. **enter** will submit your selection. | ||
| Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification. |
There was a problem hiding this comment.
I would remove 'small note:'. It's a requirement not a small note ;-)
There was a problem hiding this comment.
This is also something that's the same in all Flynt readmes.
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "name": "@flyntwp/generator-flynt", | |||
| "version": "0.1.0", | |||
| "description": "Yeoman Generator for the Flynt Framework", | |||
| "description": "A Yeoman generator for Flynt", | |||
There was a problem hiding this comment.
I preferred it as "the Flynt Framework" but that's me..
No description provided.