From b8ce411292e3855e88a9abda5370a280a206a550 Mon Sep 17 00:00:00 2001 From: James Harris Date: Mon, 13 Feb 2017 23:56:53 +0000 Subject: [PATCH] Add CONTRIBUTING --- CONTRIBUTING.md | 61 ++++++++++++++++++++ README.md | 150 +++++++++++++++++++++++++++--------------------- README.zh_cn.md | 2 +- README.zh_tw.md | 2 +- 4 files changed, 149 insertions(+), 66 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..306c47e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,61 @@ +# Contributing +The goal is to be a repository for the original Apollo 11 source +code. + +As such, [Pull Requests][0] are welcome for any issues identified +between the transcriptions in this repository and the GAP scans for +[Luminary 099][1] and [Comanche 055][2], as well as any missing +files. + +## How to Contribute + +## Guidelines +### Comments +- Comments in the transcribed code should match 1:1 with the +respective image. + - 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 only contain 1 +to 2 blank lines in a row. Lines with `R0000` 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 number. + - 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 + +## Formatting + +[AGC Assembly][4] for Sublime Text 3 and [Language AGC][5] for Atom + will ensure you're using the correct formatting automatically. + +[AGC Assembly][3] for Visual Studio Code provides language-specific +settings overrides to add to your user settings [here][6]. + +- Use tab indentation +- Use tab width of 8 +- Trim trailing whitespace + +## 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] +- [Atom][5] + +[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 \ No newline at end of file diff --git a/README.md b/README.md index 44cc59b..d02c157 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,105 @@ 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. -##Compilation -If you are interested in compiling the original source code, check out [Virtual AGC](https://github.com/rburkey2005/virtualagc). +Original Apollo 11 guidance computer (AGC) source code for Command +Module (Comanche055) and Lunar Module (Luminary099). Digitized by +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. -##Attribution +## Contributing +Please read **[CONTRIBUTING][4]** before opening a pull request. - Copyright: Public domain. - Filename: CONTRACT_AND_APPROVALS.agc - Purpose: Part of the source code for Colossus 2A, AKA Comanche 055. - It is part of the source code for the Command Module's (CM) - Apollo Guidance Computer (AGC), for Apollo 11. - Assembler: yaYUL - Contact: Ron Burkey . - Website: www.ibiblio.org/apollo. - Mod history: 2009-05-06 RSB Transcribed from page images. +## Compiling +If you are interested in compiling the original source code, check +out [Virtual AGC][5]. - This source code has been transcribed or otherwise adapted from digitized - images of a hardcopy from the MIT Museum. The digitization was performed - by Paul Fjeld, and arranged for by Deborah Douglas of the Museum. Many - thanks to both. The images (with suitable reduction in storage size and - consequent reduction in image quality as well) are available online at - www.ibiblio.org/apollo. If for some reason you find that the images are - illegible, contact me at info@sandroid.org about getting access to the - (much) higher-quality images which Paul actually created. +## Attribution +```plain +Copyright: Public domain. +Filename: CONTRACT_AND_APPROVALS.agc +Purpose: Part of the source code for Colossus 2A, AKA Comanche 055. + It is part of the source code for the Command Module's (CM) + Apollo Guidance Computer (AGC), for Apollo 11. +Assembler: yaYUL +Contact: Ron Burkey . +Website: www.ibiblio.org/apollo. +Mod history: 2009-05-06 RSB Transcribed from page images. - Notations on the hardcopy document read, in part: +This source code has been transcribed or otherwise adapted from digitized +images of a hardcopy from the MIT Museum. The digitization was performed +by Paul Fjeld, and arranged for by Deborah Douglas of the Museum. Many +thanks to both. The images (with suitable reduction in storage size and +consequent reduction in image quality as well) are available online at +www.ibiblio.org/apollo. If for some reason you find that the images are +illegible, contact me at info@sandroid.org about getting access to the +(much) higher-quality images which Paul actually created. - Assemble revision 055 of AGC program Comanche by NASA - 2021113-051. 10:28 APR. 1, 1969 +Notations on the hardcopy document read, in part: - Page 1 +Assemble revision 055 of AGC program Comanche by NASA +2021113-051. 10:28 APR. 1, 1969 - #************************************************************************ - # * - # THIS AGC PROGRAM SHALL ALSO BE REFERRED TO AS: * - # * - # * - # COLOSSUS 2A * - # * - # * - # THIS PROGRAM IS INTENDED FOR USE IN THE CM AS SPECIFIED * - # IN REPORT R-577. THIS PROGRAM WAS PREPARED UNDER DSR * - # PROJECT 55-23870, SPONSORED BY THE MANNED SPACECRAFT * - # CENTER OF THE NATIONAL AERONAUTICS AND SPACE * - # ADMINISTRATION THROUGH CONTRACT NAS 9-4065 WITH THE * - # INSTRUMENTATION LABORATORY, MASSACHUSETTS INSTITUTE OF * - # TECHNOLOGY, CAMBRIDGE, MASS. * - # * - #************************************************************************ +Page 1 + +#************************************************************************ +# * +# THIS AGC PROGRAM SHALL ALSO BE REFERRED TO AS: * +# * +# * +# COLOSSUS 2A * +# * +# * +# THIS PROGRAM IS INTENDED FOR USE IN THE CM AS SPECIFIED * +# IN REPORT R-577. THIS PROGRAM WAS PREPARED UNDER DSR * +# PROJECT 55-23870, SPONSORED BY THE MANNED SPACECRAFT * +# CENTER OF THE NATIONAL AERONAUTICS AND SPACE * +# ADMINISTRATION THROUGH CONTRACT NAS 9-4065 WITH THE * +# INSTRUMENTATION LABORATORY, MASSACHUSETTS INSTITUTE OF * +# TECHNOLOGY, CAMBRIDGE, MASS. * +# * +#************************************************************************ - SUBMITTED: MARGARET H. HAMILTON DATE: 28 MAR 69 - M.H.HAMILTON, COLOSSUS PROGRAMMING LEADER - APOLLO GUIDANCE AND NAVIGATION +SUBMITTED: MARGARET H. HAMILTON DATE: 28 MAR 69 + M.H.HAMILTON, COLOSSUS PROGRAMMING LEADER + APOLLO GUIDANCE AND NAVIGATION - APPROVED: DANIEL J. LICKLY DATE: 28 MAR 69 - D.J.LICKLY, DIRECTOR, MISSION PROGRAM DEVELOPMENT - APOLLO GUIDANCE AND NAVIGATION PROGRAM +APPROVED: DANIEL J. LICKLY DATE: 28 MAR 69 + D.J.LICKLY, DIRECTOR, MISSION PROGRAM DEVELOPMENT + APOLLO GUIDANCE AND NAVIGATION PROGRAM - APPROVED: FRED H. MARTIN DATE: 28 MAR 69 - FRED H. MARTIN, COLOSSUS PROJECT MANAGER - APOLLO GUIDANCE AND NAVIGATION PROGRAM +APPROVED: FRED H. MARTIN DATE: 28 MAR 69 + FRED H. MARTIN, COLOSSUS PROJECT MANAGER + APOLLO GUIDANCE AND NAVIGATION PROGRAM - APPROVED: NORMAN E. SEARS DATE: 28 MAR 69 - N.E. SEARS, DIRECTOR, MISSION DEVELOPMENT - APOLLO GUIDANCE AND NAVIGATION PROGRAM +APPROVED: NORMAN E. SEARS DATE: 28 MAR 69 + N.E. SEARS, DIRECTOR, MISSION DEVELOPMENT + APOLLO GUIDANCE AND NAVIGATION PROGRAM - APPROVED: RICHARD H. BATTIN DATE: 28 MAR 69 - R.H. BATTIN, DIRECTOR, MISSION DEVELOPMENT - APOLLO GUIDANCE AND NAVIGATION PROGRAM +APPROVED: RICHARD H. BATTIN DATE: 28 MAR 69 + R.H. BATTIN, DIRECTOR, MISSION DEVELOPMENT + APOLLO GUIDANCE AND NAVIGATION PROGRAM - APPROVED: DAVID G. HOAG DATE: 28 MAR 69 - D.G. HOAG, DIRECTOR - APOLLO GUIDANCE AND NAVIGATION PROGRAM +APPROVED: DAVID G. HOAG DATE: 28 MAR 69 + D.G. HOAG, DIRECTOR + APOLLO GUIDANCE AND NAVIGATION PROGRAM - APPROVED: RALPH R. RAGAN DATE: 28 MAR 69 - R.R. RAGAN, DEPUTY DIRECTOR - INSTRUMENTATION LABORATORY +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 diff --git a/README.zh_cn.md b/README.zh_cn.md index 75b5eb2..f41d8a6 100644 --- a/README.zh_cn.md +++ b/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。 diff --git a/README.zh_tw.md b/README.zh_tw.md index 0447b22..96b55bb 100644 --- a/README.zh_tw.md +++ b/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。當然，也包括那些我可能遺忘的文件。