From f2a07836bc659e70472ee4d362542844dff26854 Mon Sep 17 00:00:00 2001 From: Jackson Mooring <45497076+Gninoskcaj@users.noreply.github.com> Date: Thu, 13 Jun 2019 18:13:46 -0500 Subject: [PATCH] ImproveREADME.md Make README.md more appealing to the eye. --- README.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7d0af8ac2e..3049b5c417 100644 --- a/README.md +++ b/README.md @@ -33,24 +33,31 @@ Learn more at the [Svelte website](https://svelte.dev), or stop by the [Discord Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and help us out! -To install and work on Svelte locally: +To work on Svelte locally: +Clone repo: ```bash -git clone https://github.com/sveltejs/svelte.git -cd svelte -npm install +$ git clone https://github.com/sveltejs/svelte.git +``` + +Install dependencies: +```bash +$ cd svelte +``` +```bash +$ npm install ``` To build the compiler, and all the other modules included in the package: ```bash -npm run build +$ 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 +$ npm run dev ``` The compiler is written in [TypeScript](https://www.typescriptlang.org/), but don't let that put you off — it's basically just JavaScript with type annotations. You'll pick it up in no time. If you're using an editor other than [Visual Studio Code](https://code.visualstudio.com/) you may need to install a plugin in order to get syntax highlighting and code hints etc. @@ -59,27 +66,34 @@ The compiler is written in [TypeScript](https://www.typescriptlang.org/), but do ### Running Tests ```bash -npm run test +$ npm run test ``` To filter tests, use `-g` (aka `--grep`). For example, to only run tests involving transitions: ```bash -npm run test -- -g transition +$ npm run test -- -g transition ``` -## svelte.dev +## 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.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.dev). To develop locally: +To develop locally: ```bash -cd site -npm install && npm run update -npm run dev +$ cd site +``` +```bash +$ npm install && npm run update +``` +```bash +$ npm run dev ``` ## License [MIT](LICENSE) +