ryan/Apollo-11
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Contributing: Add more text editors with AGC syntax support (#553)

Browse Source 
* docs: add more text editors with AGC syntax support

* docs: update list for AR, KO_KR, PT_BR and TR

* Add Turkish translation for auto formatting

* Move auto formatting note to a footnote

* Update CONTRIBUTING.ar.md

* Update CONTRIBUTING.ko_kr.md

* Update CONTRIBUTING.pt_br.md

* Update CONTRIBUTING.ar.md

* Update CONTRIBUTING.ko_kr.md

* Update CONTRIBUTING.pt_br.md
This commit is contained in:
James Harris
2020-02-19 05:25:00 +00:00
committed by GitHub
parent a084af23b4
commit eb6bc89b2d
5 changed files with 121 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
CONTRIBUTING.md
View File

@ -24,17 +24,33 @@ The source code in this repository was digitized manually from paper printouts,
## Useful Extensions
GitHub has syntax support for the AGC assembly language built-in.
Unfortunately your code editor will not, however there are
AGC language extensions that provides syntax highlighting for the
following editors:
- [Atom][5]
- [Sublime Text 3][4]
- [Visual Studio Code][3]
GitHub has syntax support for the AGC assembly language built-in. Unfortunately your code editor will not, however there are AGC language extensions that provides syntax highlighting for the following editors:
- [Atom][Atom]†
- [CodeBlocks][CodeBlocks]
- [Eclipse][Eclipse]
- [Kate][Kate]
- [ProgrammersNotepad][ProgrammersNotepad]
- [Sublime Text 3][Sublime Text]†
- [TextPad][TextPad]
- [Vim][Vim]
- [Visual Studio Code][VisualStudioCode]†
- [jEdit][jEdit]
† Supports automatic formatting
[Atom]:https://github.com/Alhadis/language-agc
[CodeBlocks]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/CodeBlocks
[Eclipse]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Eclipse
[Kate]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/Kate
[ProgrammersNotepad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/ProgrammersNotepad
[Sublime Text]:https://github.com/jimlawton/AGC-Assembly
[TextPad]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/TextPad
[Vim]:https://github.com/wsdjeg/vim-assembly
[VisualStudioCode]:https://github.com/wopian/agc-assembly
[jEdit]:https://github.com/virtualagc/virtualagc/tree/master/Contributed/SyntaxHighlight/jEdit
## Formatting
**Note:** GitHub and the 3 extensions listed above will ensure
you're using the correct formatting automatically.
**Note:** GitHub and extensions marked above will ensure you're using the correct formatting automatically.
- Use tab indentation
- Use tab width of 8
@ -45,20 +61,14 @@ Any discrepancies between the scans and the source code in this repository, incl
### Comments
- Comments in the transcribed code should match the scans exactly
- This could involve creating a deliberate typo or removing/adding
an entire comment.
- This could involve creating a deliberate typo or removing/adding an entire comment.
### Line breaks
- Line breaks *with* `R0000` in column 1 should match the scans exactly.
- Line breaks *with**__out__* `R0000` in column 1 should contain only 1
or 2 blank lines in a row.
- If there are more than 2 blank lines breaks, strip the extra
line breaks.
- Line breaks *with**__out__* `R0000` in column 1 should contain only 1 or 2 blank lines in a row.
- If there are more than 2 blank lines breaks, strip the extra line breaks.
- Lines with `R0000` in column 1 do not count towards this.
- In the source images, these were created by an unprinted digit
in column 8. A 2 there forced a double space (single blank line)
and a 3 forced a triple space (double blank line). Values 4-8 were
defined but never used. Read more about it in [#159][7]
- In the source images, these were created by an unprinted digit in column 8. A 2 there forced a double space (single blank line) and a 3 forced a triple space (double blank line). Values 4-8 were defined but never used. Read more about it in [#159][7]
For example the following:
```plain
@ -102,9 +112,6 @@ Before you make a PR, please make sure your changes are consistent with the scan
[0]:https://github.com/chrislgarry/Apollo-11/pull/new/master
[1]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
[2]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
[3]:https://github.com/wopian/agc-assembly
[4]:https://github.com/jimlawton/AGC-Assembly
[5]:https://github.com/Alhadis/language-agc
[6]:https://github.com/wopian/agc-assembly#user-settings
[7]:https://github.com/chrislgarry/Apollo-11/issues/159
[8]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/