docs: move Building documentation to README
[skip ci]
This commit is contained in:
parent
062d0e12af
commit
ee43de9e5e
|
@ -13,16 +13,6 @@ to start nurturing a community because of
|
|||
|
||||
So I may not be very responsive to PRs or issues. Thanks for understanding.
|
||||
|
||||
## Building
|
||||
|
||||
To build Pinafore for production:
|
||||
|
||||
npm install
|
||||
npm run build
|
||||
PORT=4002 npm start
|
||||
|
||||
Now Pinafore is running at `localhost:4002`.
|
||||
|
||||
## Development
|
||||
|
||||
To run a dev server with hot reloading:
|
||||
|
|
17
README.md
17
README.md
|
@ -49,6 +49,19 @@ Compatible versions of each (Opera, Brave, Samsung, etc.) should be fine.
|
|||
- Admin/moderation panel
|
||||
- Works offline in read-write mode (would require sophisticated sync logic)
|
||||
|
||||
## Building and contributing
|
||||
## Building
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md).
|
||||
To build Pinafore for production:
|
||||
|
||||
npm install
|
||||
npm run build
|
||||
PORT=4002 npm start
|
||||
|
||||
Now Pinafore is running at `localhost:4002`.
|
||||
|
||||
Pinafore requires [Node.js](https://nodejs.org/en/) v8+.
|
||||
|
||||
## Developing and testing
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/nolanlawson/pinafore/blob/master/CONTRIBUTING.md) for
|
||||
how to run Pinafore in dev mode and run tests.
|
||||
|
|
Loading…
Reference in a new issue