diff --git a/README.md b/README.md index 4d03eca934..585dcb162d 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,10 @@

+

+ English • + Português (Brasil) • +

## What is Svelte? @@ -28,7 +32,6 @@ Svelte is a new way to build web applications. It's a compiler that takes your d Learn more at the [Svelte website](https://svelte.dev), or stop by the [Discord chatroom](https://svelte.dev/chat). - ## Development 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! @@ -55,7 +58,6 @@ 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. - ### Running Tests ```bash @@ -68,7 +70,6 @@ To filter tests, use `-g` (aka `--grep`). For example, to only run tests involvi 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.dev). To develop locally: @@ -79,7 +80,6 @@ npm install && npm run update npm run dev ``` - ## License [MIT](LICENSE) diff --git a/docs/README-en.md b/docs/README-en.md new file mode 100644 index 0000000000..4d03eca934 --- /dev/null +++ b/docs/README-en.md @@ -0,0 +1,85 @@ +

+ + Cybernetically enhanced web apps: Svelte + + + + npm version + + + + install size + + + + build status + + + + license + +

+ + +## What is Svelte? + +Svelte is a new way to build web applications. It's a compiler that takes your declarative components and converts them into efficient JavaScript that surgically updates the DOM. + +Learn more at the [Svelte website](https://svelte.dev), or stop by the [Discord chatroom](https://svelte.dev/chat). + + +## Development + +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: + +```bash +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 +``` + +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. + + +### Running Tests + +```bash +npm run test +``` + +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.dev). To develop locally: + +```bash +cd site +npm install && npm run update +npm run dev +``` + + +## License + +[MIT](LICENSE) diff --git a/docs/README-ptbr.md b/docs/README-ptbr.md new file mode 100644 index 0000000000..d678d7b549 --- /dev/null +++ b/docs/README-ptbr.md @@ -0,0 +1,80 @@ +

+ + Cybernetically enhanced web apps: Svelte + + + + npm version + + + + install size + + + + build status + + + + license + +

+ +## O que é Svelte? + +Svelte é um novo jeito de construir aplicações web. É um compilador que pega seus componentes declarativos e os converte em JavaScript eficiente que atualiza com grande precisão o DOM. + +Saiba mais no [site do Svelte](https://svelte.dev), ou visite a [sala do Discord](https://svelte.dev/chat). + +## Desenvolvimento + +Pull requests são incentivados e sempre bem-vindos. [Escolha um issue](https://github.com/sveltejs/svelte/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) e nos ajude! + +Para instalar e trabalhar com o Svelte localmente: + +```bash +git clone git@github.com:sveltejs/svelte.git +cd svelte +npm install +``` + +Para construir o compilador e todos os outros módulos incluídos no pacote: + +```bash +npm run build +``` + +Para observar as alterações e reconstruir continuamente o pacote (isso é útil se você estiver usando o [npm link](https://docs.npmjs.com/cli/link.html) para testar as alterações em um projeto localmente): + +```bash +npm run dev +``` + +O compilador é escrito em [TypeScript](https://www.typescriptlang.org/), mas não deixe que isso te afaste - é basicamente apenas JavaScript com anotações de tipagem. Você vai entende-lo num instante. Se você estiver usando um editor diferente do [Visual Studio Code](https://code.visualstudio.com/), pode ser necessário instalar um plugin para obter um destaque da sintaxe e dicas de código, etc. + +### Executando testes + +```bash +npm run test +``` + +Para filtrar os testes, use `-g` (também conhecido como `--grep`). Por exemplo, para executar somente testes envolvendo transições: + +```bash +npm run test -- -g transition +``` + +## svelte.dev + +O código-fonte para https://svelte.dev, incluindo toda a documentação, está no diretório [site](site). O site é construído com [Sapper](https://sapper.svelte.dev). Para desenvolver localmente: + +```bash +cd site +npm install && npm run update +npm run dev +``` + +## Licença + +[MIT](LICENSE)