From 3d61573afb4608b65e5abf85dac11eae974e6b39 Mon Sep 17 00:00:00 2001 From: Robert Hall Date: Wed, 25 Jul 2018 09:49:56 -0600 Subject: [PATCH] Some basic dev docs --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index aa2ea7485c..de2e7c06d5 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,42 @@ The `style` and `script` preprocessors will run *after* the `markup` preprocesso

To keep Svelte's performance in check, we use BrowserStack to quickly run benchmarks for each PR that immediately give feedback to the contributor. You can see how we use BrowserStack in the svelte-bench project and check out BrowserStack's services on their website.

+## Development + +PRs are encouraged and always welcome. Pick an issue and help us out! + +To install and work on Svelte locally: + +```bash +git clone git@github.com:sveltejs/svelte.git +cd svelte +npm install +npm run dev +``` + +### Linking to a Live Project + +From the root of your local svelte git checkout: + +```bash +npm link +``` + +Then, to link from any given project: + +```bash +cd my-project +npm link svelte +``` + +You can then continue to make changes locally to the Svelte project and test it against a local project. For a quick project that takes almost no setup, use the default [sapper-template](https://github.com/sveltejs/sapper-template) project, which employs both Svelte and [Sapper](https://sapper.svelte.technology/). Instructions on setting up the default Sapper template are found in the [repo page](https://github.com/sveltejs/sapper-template). + +### Running Tests + +```bash +npm run test +``` + ## License [MIT](LICENSE)