Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagodp committed Jun 14, 2019
1 parent 09166b6 commit d5cf478
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Execute the following command to guide the setup process:
```bash
concordia --init
```
👉 On **Linux** or **MacOS**, you need to use `sudo` before the command, since it may be needed to install some applications globally.
👉 On **Linux** or **MacOS** you may need to use `sudo` before the command whether your **NodeJS' version is less than `8.2`** or you are using Concordia `0.x`.

You'll be asked about your preferences and they will be stored in a configuration file named `.concordiarc`. **LET ALL THE DEFAULT VALUES**, by typing <kbd>Enter</kbd> for all the questions.

Expand Down
12 changes: 10 additions & 2 deletions docs/en/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ Before reading, you may wish to know [how the Concordia project numbers its vers

- [From version `0.x` to `1.x`](#from-version-0x-to-1x)
- [What did break the compatibility?](#what-did-break-the-compatibility)
- [Concordia Compiler](#concordia-compiler)
- [Concordia Language](#concordia-language)
- [Other relevant changes](#other-relevant-changes)
- [FAQ](#faq)
- [How to migrate](#how-to-migrate)

## From version `0.x` to `1.x`

### What did break the compatibility?

In the **Concordia Compiler**:
#### Concordia Compiler

1. It changed the way that all the plug-in operations are handled. See [Issue #34](https://github.com/thiagodp/concordialang/issues/34) for details.
2. The behavior of the following plug-in commands:
Expand All @@ -26,8 +29,13 @@ In the **Concordia Compiler**:

👉 See the [Command Documentation](./commands.md) to know the commands' syntax.

#### Concordia Language

No compatibility breaks in the **Concordia Language**.
No compatibility breaks.

#### Other relevant changes

External tools used by plug-ins are now installed locally, per project, instead of installed globally. Their direct execution (without using Concordia) is now possible through NPX. For example, the command `codeceptjs run test.js` must now be executed as `npx codeceptjs run test.js`. This change also allows the installation of different versions of external tools, when needed.

### FAQ

Expand Down
13 changes: 11 additions & 2 deletions docs/pt/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ Antes de ler, pode ser útil entender [como o projeto Concordia numera suas vers

- [Versão `0.x` para `1.x`](#vers%C3%A3o-0x-para-1x)
- [O que quebrou a compatibilidade?](#o-que-quebrou-a-compatibilidade)
- [Compilador Concordia](#compilador-concordia)
- [Linguagem Concordia](#linguagem-concordia)
- [Outras mudanças relevantes](#outras-mudan%C3%A7as-relevantes)
- [FAQ](#faq)
- [Como migrar](#como-migrar)

## Versão `0.x` para `1.x`

### O que quebrou a compatibilidade?

No **Compilador Concordia**:
#### Compilador Concordia

1. Mudou a forma como ele realiza todas as operações com plug-ins. Veja a [Issue #34](https://github.com/thiagodp/concordialang/issues/34) para detalhes.
2. O comportamento dos seguintes comandos de plug-in:
Expand All @@ -27,7 +30,13 @@ No **Compilador Concordia**:
👉 Consulte a [Documentação dos Comandos](./commands.md) para saber a sintaxe dos comandos acima.


Na **Linguagem Concordia** não houve quebras de compatibilidade.
#### Linguagem Concordia

Nenhuma quebra de compatibilidade.

#### Outras mudanças relevantes

Ferramentas externas utilizadas por plug-ins agora são instaladas de forma local, para o projeto, em vez de instaladas de forma global. A execução direta delas (sem usar o Concordia) passa a ser realizada através do NPX. Por exemplo, quem antes executava `codeceptjs run teste.js`, deve passar a executar `npx codeceptjs run teste.js`. Essa novidade também possibilita usar versões diferentes das ferramentas externas, caso necessário.

### FAQ

Expand Down
2 changes: 1 addition & 1 deletion readme-pt.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Execute o seguinte comando para guiar o processo de configuração:
```bash
concordia --init
```
👉 No **Linux** ou **MacOS**, use `sudo` antes do comando, pois deve ser preciso instalar aplicações de forma global.
👉 No **Linux** ou **MacOS**, você pode precisar usar `sudo` antes do comando, caso sua **versão do NodeJS for menor que `8.2`**, ou se você está usando Concordia `0.x`.

Serão feitas algumas perguntas sobre suas preferências e elas serão armazenadas em um arquivo chamado `.concordiarc`. **DEIXE TODOS OS VALORES PADRÃO** teclando <kbd>Enter</kbd> em todas as perguntas.

Expand Down

0 comments on commit d5cf478

Please sign in to comment.