From 17829049945023b83efcd8e8a713d72869a6a21f Mon Sep 17 00:00:00 2001 From: Robert Hall Date: Wed, 25 Jul 2018 10:10:22 -0600 Subject: [PATCH] Some dev documentation --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 87d57a6..4ef3e4a 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,44 @@ npm run build npm start ``` +## Development + +Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/sapper/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out! + +To install and work on Sapper locally: + +```bash +git clone git@github.com:sveltejs/sapper.git +cd sapper +npm install +npm run dev +``` + +### Linking to a Live Project + +You can make changes locally to Sapper and test it against a local Sapper project. For a quick project that takes almost no setup, use the default [sapper-template](https://github.com/sveltejs/sapper-template) project. Instruction on setup are found in that project repository. + +To link Sapper to your project, from the root of your local Sapper git checkout: + +```bash +cd sapper +npm link +``` + +Then, to link from `sapper-template` (or any other given project): + +```bash +cd sapper-template +npm link sapper +``` + +You should be good to test changes locally. + +### Running Tests + +```bash +npm run test +``` ## License