mirror of
https://github.com/pcottle/learnGitBranching.git
synced 2025-08-01 00:25:15 +02:00
readme
This commit is contained in:
parent
6748f66dfc
commit
8cfd9ebd19
1 changed files with 12 additions and 3 deletions
15
README.md
15
README.md
|
@ -26,11 +26,17 @@ You can build levels with `build level`. The dialog should walk you through the
|
||||||
|
|
||||||
### Contributing Levels
|
### Contributing Levels
|
||||||
|
|
||||||
I would love for more levels to be added! I think there is a ton to learn and cover. Hopefully the community together can build a great tool for all git newcomers.
|
I would love for more levels to be added! I think there is a ton to learn and cover. Hopefully the community together can build a great tool for all git newcomers. You can make your own levels with
|
||||||
|
|
||||||
## Contributing
|
```
|
||||||
|
build level
|
||||||
|
```
|
||||||
|
|
||||||
I am really loose about contributing levels. For contributing functionality, you will need to install the `grunt` build tool. The general steps:
|
In the application. You will be walked through the process, and at the end you can `export level` to get a JSON blob. Paste that in a gist or directly into an issue and I can check it out / merge in your changes!
|
||||||
|
|
||||||
|
## Contributing Functionality
|
||||||
|
|
||||||
|
For contributing core functionality in the app, you will need to install the `grunt` build tool. The general steps:
|
||||||
|
|
||||||
```
|
```
|
||||||
git clone <your fork of the repo>
|
git clone <your fork of the repo>
|
||||||
|
@ -38,6 +44,9 @@ cd learnGitBranching
|
||||||
npm install
|
npm install
|
||||||
git checkout -b newAwesomeFeature
|
git checkout -b newAwesomeFeature
|
||||||
# some changes
|
# some changes
|
||||||
|
grunt build # now you can open up your browser to the index.html and see your changes
|
||||||
|
grunt watch # will keep watch over files and fastBuild whenever they change
|
||||||
|
# more changes
|
||||||
grunt build
|
grunt build
|
||||||
git commit -am "My new sweet feature!"
|
git commit -am "My new sweet feature!"
|
||||||
git push
|
git push
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue