diff --git a/README.md b/README.md index a9cdfdcb8d..6dd84b18a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
@@ -22,6 +22,17 @@ To install and work on Svelte locally: git clone git@github.com:sveltejs/svelte.git cd svelte npm install +``` + +To build the compiler, and all the other modules included in the package: + +```bash +npm run build +``` + +To watch for changes and continually rebuild the package (this is useful if you're using [npm link](https://docs.npmjs.com/cli/link.html) to test out changes in a project locally): + +```bash npm run dev ``` @@ -34,13 +45,24 @@ The compiler is written in [TypeScript](https://www.typescriptlang.org/), but do npm run test ``` -For running single tests, you can use pattern matching. For example, to run all the tests involving transitions: +To filter tests, use `-g` (aka `--grep`). For example, to only run tests involving transitions: ```bash npm run test -- -g transition ``` +## svelte.dev + +The source code for https://svelte.dev, including all the documentation, lives in the [site](site) directory. The site is built with [Sapper](https://sapper.svelte.technology) To develop locally: + +```bash +cd site +npm install +npm run dev +``` + + ## License [MIT](LICENSE) diff --git a/banner.png b/banner.png new file mode 100644 index 0000000000..8b7c8c2366 Binary files /dev/null and b/banner.png differ