From ee43de9e5e077c387f21ce11feb9607ffbfae74e Mon Sep 17 00:00:00 2001 From: Nolan Lawson Date: Sun, 15 Apr 2018 09:48:52 -0700 Subject: [PATCH] docs: move Building documentation to README [skip ci] --- CONTRIBUTING.md | 10 ---------- README.md | 17 +++++++++++++++-- 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c56b55b0..5c913f95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: diff --git a/README.md b/README.md index e8a4ae78..1af13961 100644 --- a/README.md +++ b/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.