Skip to content

Commit 7c9de7d

Browse files
authored
Update README.md
Added tutorial to run the generator on a local machine.
1 parent 327edd3 commit 7c9de7d

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ There is a Java rewrite in progress, which will be overall better than the elect
88

99
If you find any issues, report them on the github here, and Deviouslrd will attend to it!
1010

11+
## Local Development Fork
12+
13+
To edit this generator for your own purposes, theres just a couple steps.
14+
1. Clone the repo to a local folder (easy to do with the github desktop app, or via cli)
15+
2. Open the repo in your favourite code editor, and open a terminal of sorts.
16+
3. Run `npm i` to install all the dependencies and to acquire the node modules required to run it.
17+
4. When that is finished, run `npm start` or `npm run start` to run the program.
18+
5. Enjoy the chaos that is the JSON generator. (I'm not kidding)
19+
1120
Credits:
1221
- [Deviouslrd](https://github.com/Deviouslrd) - Primary programmer
1322
- [Siuolthepic](https://github.com/Siuolthepic) - JSON help, code improvements

0 commit comments

Comments
 (0)