Merge pull request #278 from chrislgarry/contrib

Add CONTRIBUTING + EditorConfig

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.agc]
+indent_style = tab
+tab_width = 8
+
+[*.md]
+indent_style = space
+indent_size = 2

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing
+## 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]
+
+## Formatting
+**Note:** GitHub and the 3 extensions listed above will ensure
+you're using the correct formatting automatically.
+
+- Use tab indentation
+- Use tab width of 8
+- Trim trailing whitespace
+
+## What do I check?
+### Comments
+- 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 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.
+    - 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
+```
+
+[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

README.md

@@ -1,14 +1,25 @@
 Apollo-11
 =========
 
-*Also available in: [English](README.md), [简体中文](README.zh_cn.md), [正體中文](README.zh_tw.md).*
+*Available in: [English][EN], [简体中文][ZH_CN], [正體中文][ZH_TW].*
 
-Original Apollo 11 guidance computer (AGC) source code for Command Module (Comanche055) and Lunar Module (Luminary099). Digitized by the folks at [Virtual AGC](http://www.ibiblio.org/apollo/) and [MIT Museum](http://web.mit.edu/museum/). The goal is to be a repo for the original Apollo 11 source code. As such, PRs are welcome for any issues identified between the transcriptions in this repository and the original source scans for [Luminary 099](http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/) and [Comanche 055](http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/), as well as any files I may have missed.
+Original Apollo 11 guidance computer (AGC) source code for Command
-##Compilation
+Module (Comanche055) and Lunar Module (Luminary099). Digitized by
-If you are interested in compiling the original source code, check out [Virtual AGC](https://github.com/rburkey2005/virtualagc).
+the folks at [Virtual AGC][0] and [MIT Museum][1]. The goal is to be
+a repo for the original Apollo 11 source code. As such, PRs are
+welcome for any issues identified between the transcriptions in this
+repository and the original source scans for [Luminary 099][2] and
+[Comanche 055][3], as well as any files I may have missed.
+
+## Contributing
+Please read [CONTRIBUTING.md][4] before opening a pull request.
+
+## Compiling
+If you are interested in compiling the original source code, check
+out [Virtual AGC][5].
 
 ## Attribution
-
+```plain
 Copyright: Public domain.
 Filename:  CONTRACT_AND_APPROVALS.agc
 Purpose:   Part of the source code for Colossus 2A, AKA Comanche 055.
@@ -81,3 +92,14 @@ If you are interested in compiling the original source code, check out [Virtual
 APPROVED:   RALPH R. RAGAN          DATE:   28 MAR 69
     R.R. RAGAN, DEPUTY DIRECTOR
     INSTRUMENTATION LABORATORY
+```
+
+[EN]:README.md
+[ZH_CN]:README.zh_cn.md
+[ZH_TW]:README.zh_tw.md
+[0]:http://www.ibiblio.org/apollo/
+[1]:http://web.mit.edu/museum/
+[2]:http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/
+[3]:http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/
+[4]:https://github.com/chrislgarry/Apollo-11/blob/master/CONTRIBUTING.md
+[5]:https://github.com/rburkey2005/virtualagc

README.zh_cn.md

@@ -1,7 +1,7 @@
 阿波罗11号
 =========
 
-*Also available in: [English](README.md), [简体中文](README.zh_cn.md), [正體中文](README.zh_tw.md).*
+*Available in: [English](README.md), [简体中文](README.zh_cn.md), [正體中文](README.zh_tw.md).*
 
 阿波罗11号制导计算机（AGC）中指令模块（Comanche055）和登月模块（Luminary099）原始代码。由[虚拟 AGC](http://www.ibiblio.org/apollo/) 和 [MIT 科学博物馆](http://web.mit.edu/museum/) 的伙计们完成电子化。本仓库的目的是存储阿波罗11号原始代码。当然，倘若在本仓库或原始代码扫描件[Luminary 099](http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/) 及 [Comancheion 055](http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/) 发现问题，或者任何我可能漏掉的文件，欢迎提交PRs。
 

README.zh_tw.md

@@ -1,7 +1,7 @@
 阿波羅11號
 =========
 
-*Also available in: [English](README.md), [简体中文](README.zh_cn.md), [正體中文](README.zh_tw.md).*
+*Available in: [English](README.md), [简体中文](README.zh_cn.md), [正體中文](README.zh_tw.md).*
 
 原版的阿波羅11號電腦（Apollo 11 Guidance computer, AGC）用於駕駛艙（Comanche055）和登月艙（Luminary099）的原始碼，由 [Virtual AGC](http://www.ibiblio.org/apollo/) 及 [MIT Museum](http://web.mit.edu/museum/) 的工作人員數位化，目的在於建立一個存放阿波羅11號原始碼的程式庫。正因如此，若你在文件抄錄上或在查看 [Luminary 099](http://www.ibiblio.org/apollo/ScansForConversion/Luminary099/) 和 [Comanche 055](http://www.ibiblio.org/apollo/ScansForConversion/Comanche055/) 這兩部分原始碼過程中遇到問題的話，我們歡迎你能提起一個 PR。當然，也包括那些我可能遺忘的文件。