comparison docs/lyx/asm.lyx @ 42:792da050d8c4 tip

more dox

 Assembler Design
 \end_layout
 
 \begin_layout Standard
 The assembler will take assembly source code as input and produce two output
- files: A binary executable and a debug file.
+ files: a binary executable and a debug file.
 \end_layout
 
 \begin_layout Standard
 \begin_inset ERT
 status open

 This file will essentially be the plain text source side by side with the
  binary machine code and address for each instruction (represented as hexadecima
 l for greater readability).
  This file will provide the information needed for setting break pointers
  with the debugger later, it will also be generally useful for debugging
- programs written in the assembler, and the assembler it self.
+ programs written in the assembler, and the assembler itself.
 \end_layout
 
 \begin_layout Standard
 \begin_inset Newpage pagebreak
 \end_inset

 \begin_layout Subsection
 Language design in BNF syntax
 \end_layout
 
 \begin_layout Standard
-The ELB816 specification defines an assembly language in Backus Naur form,
- however the assembler designed for this project differs slightly (more
- details in Assembler Implementation below).
+The ELB816 specification [1] defines an assembly language in Backus Naur
+ form, however the assembler designed for this project differs slightly
+ (more details in Assembler Implementation below).
  Here is the language definition for this assembler:
 \end_layout
 
 \begin_layout Standard
 \begin_inset ERT

 \end_layout
 
 \begin_layout Standard
 The assembler is written in pure Python 2 using only the standard library.
  It assembles the assembly the language described in the ELB816 specification
- with a few minor differences.
+ [1] with a few minor differences.
  These differences are:
 \end_layout
 
 \begin_layout Itemize
 In-line arithmetic must be wrapped in curved brackets eg.

 \begin_layout Standard
 The following sections details the design and behavior of the assembler.
  However it must be noted that these are abstract and high level descriptions
  that do not fully explain minor routines, but give an overview of the entire
  process.
- The full commented source code is provided with the supporting and should
- be referenced for a deeper understanding of the program's operation.
+ The full commented source code is provided with the Supporting Material
+ and should be referenced for a deeper understanding of the program's operation.
  
 \end_layout
 
 \begin_layout Standard
 \begin_inset Newpage pagebreak

 \begin_layout Standard
 The assembler was tested by assembling the entire instruction table, while
  at the same time testing labels and directives.
  The test file was assembled and then the binary and .dsm files were inspected
  manually by checking their size and content.
- None of the this testing is automated and files are inspected by hand.
- The test files and results can be found in the Supporting Material
+ None of this testing is automated and files are inspected by hand.
+ The test files and results can be found in the Supporting Material.
 \end_layout
 
 \end_body
 \end_document