Update README.
rodzic
72505ac1ff
commit
bb31446260
23
README.md
23
README.md
|
@ -1,3 +1,26 @@
|
||||||
All art is by [Nina Paley][]!
|
All art is by [Nina Paley][]!
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
This requires [NodeJS][]. It was started with
|
||||||
|
NodeJS 14.15.4, but hopefully it should work with
|
||||||
|
any recent version.
|
||||||
|
|
||||||
|
After cloning the repository and entering it, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run watch
|
||||||
|
```
|
||||||
|
|
||||||
|
then visit http://localhost:1234.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
To deploy the project to GitHub Pages, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
[NodeJS]: https://nodejs.org/en/
|
||||||
[Nina Paley]: https://blog.ninapaley.com/
|
[Nina Paley]: https://blog.ninapaley.com/
|
||||||
|
|
Ładowanie…
Reference in New Issue