From 92af214239cb0fdcff9b3af7da664ac2416dc41e Mon Sep 17 00:00:00 2001 From: James Harris Date: Tue, 14 Feb 2017 00:07:17 +0000 Subject: [PATCH] Add EditorConfig --- .editorconfig | 15 +++++++++++++++ CONTRIBUTING.md | 14 +++++++------- README.md | 10 +++++----- 3 files changed, 27 insertions(+), 12 deletions(-) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..b2bec00 --- /dev/null +++ b/.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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a8df4a..813752d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ # Contributing ## Guidelines ### Comments -- Comments in the transcribed code should match 1:1 with the -respective image. +- 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. @@ -10,7 +10,7 @@ respective image. - 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. - - If there are more than 2 blank lines breaks, strip the extra + - 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 @@ -19,9 +19,9 @@ to 2 blank lines in a row. defined but never used. Read more about it in chrislgarry/Apollo-11/#159 ## Formatting -[AGC Assembly][4] for Sublime Text 3 and [Language AGC][5] for Atom +GitHub, [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]. @@ -33,7 +33,7 @@ settings overrides to add to your user settings [here][6]. 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 +extension that provides syntax highlighting for the following editors: - [Visual Studio Code][3] - [Sublime Text 3][4] @@ -46,4 +46,4 @@ editors: [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 +[7]:https://github.com/chrislgarry/Apollo-11/issues/159 diff --git a/README.md b/README.md index d02c157..08159cc 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,19 @@ Apollo-11 *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 +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 +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 +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][4]** before opening a pull request. ## Compiling -If you are interested in compiling the original source code, check +If you are interested in compiling the original source code, check out [Virtual AGC][5]. ## Attribution