ci(mdl): add markdown linter
This commit is contained in:
@ -27,12 +27,13 @@
|
||||
|
||||
Bu repodaki kaynak kodu kağıt çıktılarından elle dijitalleştirilmiştir. Yani yazım hataları ve diğer tutarsızlıklar yanlışlıkla yapılmıştır. Kod, aşağıdaki taratılmış çıktılar ile tutarlı olması için düzenlenmelidir:
|
||||
|
||||
* [AGC printouts for Comanche][8]
|
||||
* [AGC printouts for Luminary][9]
|
||||
- [AGC printouts for Comanche][8]
|
||||
- [AGC printouts for Luminary][9]
|
||||
|
||||
## Yararlı Eklentiler
|
||||
|
||||
Github, AGC assembly dili için sentaks desteği sağlıyor ama sizin kodu düzenlemek için kullandığınız editör sağlamayacaktır. Aşağıdaki editörler AGC dili sentaks vurgulaması için eklentiler sunmaktadır:
|
||||
|
||||
- [Atom][Atom]†
|
||||
- [CodeBlocks][CodeBlocks]
|
||||
- [Eclipse][Eclipse]
|
||||
@ -58,6 +59,7 @@ Github, AGC assembly dili için sentaks desteği sağlıyor ama sizin kodu düze
|
||||
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
|
||||
|
||||
## Biçimlendirme
|
||||
|
||||
**Not:** GitHub ve yukarıdaki 3 eklenti otomatik olarak doğru biçimlendirmeyi kullanmanızı sağlayacaktır.
|
||||
|
||||
- Girintilemeyi tab ile yapın
|
||||
@ -65,13 +67,16 @@ Github, AGC assembly dili için sentaks desteği sağlıyor ama sizin kodu düze
|
||||
- Devamındaki boşlukları silin
|
||||
|
||||
## Neyi kontrol edeyim?
|
||||
|
||||
Taratılmış çıktılar ve bu repodaki kaynak kodu arasındaki aşağıdakileri kapsayan herhangi bir tutarsızlığı:
|
||||
|
||||
### Yorumlar
|
||||
|
||||
- Uyarlanan koddaki yorum satırları, çıktılar ile tamamen eşleşmelidir
|
||||
- Bu bilerek yazım hatası koymayı veya bir yorumun tamamını kaldırıp/eklemeyi içerebilir.
|
||||
|
||||
### Satır sonları
|
||||
|
||||
- Birinci sütunu `R0000` *ile* biten satır sonları çıktılar ile tamamen eşleşmelidir.
|
||||
- Birinci sütunu `R0000` *__olmadan__* biten satır sonları arka arkaya sadece 1 ya da 2 boş satır içermelidir.
|
||||
- Eğer 2'den fazla satır sonu varsa ekstra olan satır sonlarını kaldırın.
|
||||
@ -79,6 +84,7 @@ Taratılmış çıktılar ve bu repodaki kaynak kodu arasındaki aşağıdakiler
|
||||
- Kaynak resimlerde bunlar 8. satırındaki basamak bastırılmamış halde oluşturulmuştur. Bir 2 kullanımı iki boşluğu (tek boş satırı) temsil ederken, bir 3 kullanımı üç boşluğu (iki boş satırı) ifade eder. 4 ve 8 tanımlanmıştır fakat hiç kullanılmamıştır. Bunun hakkında daha fazla okumak için: [#159][7].
|
||||
|
||||
Örneğin bu:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -87,7 +93,9 @@ R0820
|
||||
|
||||
0821 LAMPTEST CS IMODES33
|
||||
```
|
||||
|
||||
Buna dönüşmeli:
|
||||
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
@ -97,17 +105,21 @@ R0820
|
||||
```
|
||||
|
||||
### Boşluklar
|
||||
|
||||
- Bir string'deki iki karakterin arasındaki boşluklar şu kurallara uymalıdır ([#316][10]'daki tartışmayı inceleyin):
|
||||
- Yeni kelimeler arası tek boşluk.
|
||||
- Yeni cümleler arası iki boşluk.
|
||||
- Yeni girintiler için üç boşluk.
|
||||
|
||||
Örneğin bu:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
```
|
||||
|
||||
Buna dönüşmeli:
|
||||
|
||||
```plain
|
||||
1) FOO BAR BAZ QUX QUUX QUUZ. CORGE, GRAULT,
|
||||
GARPLY, WALDO.
|
||||
|
Reference in New Issue
Block a user