ci(mdl): add markdown linter
This commit is contained in:
@ -27,13 +27,14 @@
|
||||
|
||||
O código-fonte neste repositório foi digitado manualmente a partir de impressões em papel, logo alguns erros de digitação e discrepâncias foram introduzidos acidentalmente. O código deve ser modificado para se tornar consistente com as seguintes digitalizações:
|
||||
|
||||
* [Impressões em AGC para Comanche][8]
|
||||
* [Impressões em AGC para Luminary][9]
|
||||
- [Impressões em AGC para Comanche][8]
|
||||
- [Impressões em AGC para Luminary][9]
|
||||
|
||||
## Extensões úteis
|
||||
|
||||
Github possui suporte de sintaxe nativo para a linguagem assembly AGC.
|
||||
Infelizmente, seu editor de texto não o terá. Portanto, existem extensões para a linguagem AGC que providenciam destaque de sintaxe para os seguintes editores:
|
||||
|
||||
- [Atom][Atom]†
|
||||
- [CodeBlocks][CodeBlocks]
|
||||
- [Eclipse][Eclipse]
|
||||
@ -59,6 +60,7 @@ Infelizmente, seu editor de texto não o terá. Portanto, existem extensões par
|
||||
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
|
||||
|
||||
## Formatando
|
||||
|
||||
**Nota:** Github e as três extensões listadas acima garantirão que você estará usando a formatação correta automaticamente.
|
||||
|
||||
- Use indentação por tab
|
||||
@ -66,13 +68,16 @@ Infelizmente, seu editor de texto não o terá. Portanto, existem extensões par
|
||||
- Diminua o espaço em branco à direita
|
||||
|
||||
## O que devo conferir?
|
||||
|
||||
Quaisquer discrepâncias entre as digitalizações e o código-fonte neste repositório, incluindo:
|
||||
|
||||
### Comentários
|
||||
|
||||
- Comentários no código transcrito devem corresponder exatamente às digitalizações
|
||||
- Isso pode envolver criar um erro de digitação deliberadamente ou remover/adicionar um comentário inteiro.
|
||||
|
||||
### Quebra de linha
|
||||
|
||||
- Quebras de linha *com* `R0000` na coluna 1 devem corresponder exatamente às digitalizações.
|
||||
- Quebras de linha *sem* `R0000` na coluna 1 devem conter apenas uma ou duas linhas em branco em sequência.
|
||||
- Se existem mais de duas quebras de linha em branco, remova as quebras de linha extras.
|
||||
@ -80,6 +85,7 @@ Quaisquer discrepâncias entre as digitalizações e o código-fonte neste repos
|
||||
- As imagens fonte foram criadas por meio de um dígito não-impresso na coluna 8. Um 2 forçava um espaço duplo (linha em branco única) e um 3 forçava um espaço triplo (linha em branco dupla). Os valores de 4 até 8 foram definidos porém nunca usados. Leia mais sobre em [#159][7]
|
||||
|
||||
Por exemplo, o seguinte código:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -88,7 +94,9 @@ R0820
|
||||
|
||||
0821 LAMPTEST CS IMODES33
|
||||
```
|
||||
|
||||
Deve tornar-se:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -98,17 +106,21 @@ R0820
|
||||
```
|
||||
|
||||
### Espaços
|
||||
|
||||
- Espaços entre dois caracteres na cadeia de caracteres devem respeitar a seguinte convenção (veja a discussão em [#316][10]):
|
||||
- Espaço único para novas palavras.
|
||||
- Espaço duplo para novas sentenças.
|
||||
- Espaço triplo para indentações.
|
||||
|
||||
Por exemplo, o seguinte código:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
```
|
||||
|
||||
Deve tornar-se:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
|
Reference in New Issue
Block a user