Update with example and ordering
This commit is contained in:
parent
3d91c64e95
commit
f4d7d79cd0
@ -1,22 +1,39 @@
|
||||
# Contributing
|
||||
## What do I check?
|
||||
### Comments
|
||||
- Comments in the transcribed code should match 1:1 with the
|
||||
respective image.
|
||||
- Comments in the transcribed code should match the scans exactly
|
||||
- This could involve creating a deliberate typo or removing/adding
|
||||
an entire comment.
|
||||
|
||||
### Line breaks
|
||||
- Line breaks **with** `R0000` in column 1 should match 1:1.
|
||||
- Line breaks **without** `R0000` in column 1 should contain only 1
|
||||
- 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.
|
||||
- Lines with `R0000` in column 1 do not count towards this.
|
||||
- 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]
|
||||
|
||||
For example the following:
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
|
||||
|
||||
|
||||
0821 LAMPTEST CS IMODES33
|
||||
```
|
||||
Should become:
|
||||
```plain
|
||||
R0819 SUBROUTINE TO SKIP...
|
||||
R0820
|
||||
|
||||
|
||||
0820 LAMPTEST CS IMODES33
|
||||
```
|
||||
|
||||
## Formatting
|
||||
GitHub, [AGC Assembly][4] for Sublime Text 3 and [Language AGC][5]
|
||||
@ -33,12 +50,12 @@ settings overrides to add to your user settings [here][6].
|
||||
## Useful Extensions
|
||||
|
||||
GitHub has syntax support for the AGC assembly language built-in.
|
||||
Unfortunately your code editor will not. Luckily there is a language
|
||||
extension that provides syntax highlighting for the following
|
||||
editors:
|
||||
- [Visual Studio Code][3]
|
||||
- [Sublime Text 3][4]
|
||||
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]
|
||||
|
||||
[0]:https://github.com/chrislgarry/Apollo-11/pull/new/master
|
||||
[1]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
|
||||
|
Loading…
Reference in New Issue
Block a user