Update documentation for v1.0.0 release.

Further updates to the README.md file. Add more to the README.md file. Add more documentation to README.md. More documentation in README.md Start documenting addressing modes in README.md Final set of changes to README.md file.
craigthomas · Sep 24, 2022 · a1d1c3f · a1d1c3f
1 parent 6d930e4
commit a1d1c3f
Show file tree

Hide file tree

Showing 30 changed files with 462 additions and 107 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (C) 2013-2019 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in 

diff --git a/README.md b/README.md
diff --git a/assembler.py b/assembler.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/exceptions.py b/cocoasm/exceptions.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 This file contains Exceptions for the CoCo Assembler.

diff --git a/cocoasm/instruction.py b/cocoasm/instruction.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/operand_type.py b/cocoasm/operand_type.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/operands.py b/cocoasm/operands.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/program.py b/cocoasm/program.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 This file contains the main Program class for the CoCo Assembler.

diff --git a/cocoasm/statement.py b/cocoasm/statement.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/values.py b/cocoasm/values.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/binary.py b/cocoasm/virtualfiles/binary.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/cassette.py b/cocoasm/virtualfiles/cassette.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/coco_file.py b/cocoasm/virtualfiles/coco_file.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/disk.py b/cocoasm/virtualfiles/disk.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/source_file.py b/cocoasm/virtualfiles/source_file.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/virtual_file.py b/cocoasm/virtualfiles/virtual_file.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/virtual_file_container.py b/cocoasm/virtualfiles/virtual_file_container.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/cocoasm/virtualfiles/virtual_file_exceptions.py b/cocoasm/virtualfiles/virtual_file_exceptions.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 This file contains Exceptions for the CoCo Assembler.

diff --git a/file_util.py b/file_util.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/test_exceptions.py b/test/test_exceptions.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/test_integration.py b/test/test_integration.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 This file contains the main Program class for the CoCo Assembler.

diff --git a/test/test_operands.py b/test/test_operands.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/test_program.py b/test/test_program.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 This file contains the main Program class for the CoCo Assembler.

diff --git a/test/test_statement.py b/test/test_statement.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.
@@ -10,7 +10,7 @@
 
 from cocoasm.statement import Statement
 from cocoasm.values import NumericValue, AddressValue
-from cocoasm.exceptions import ParseError, OperandTypeError, TranslationError
+from cocoasm.exceptions import ParseError, TranslationError
 
 # C L A S S E S ###############################################################
 

diff --git a/test/test_values.py b/test/test_values.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2019-2020 Craig Thomas
+Copyright (C) 2013-2020 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.
@@ -589,7 +589,7 @@ def test_expression_resolve_symbol_subtraction_works_correctly(self):
         result = result.resolve(symbol_table)
         self.assertEqual(result.int, 1)
 
-    def test_expression_resolve_numeric_only_division_works_correctly(self):
+    def test_expression_resolve_symbol_plus_numeric_division_works_correctly(self):
         symbol_table = {"VAR": NumericValue("$04", mode=ExplicitAddressingMode.DIRECT)}
         result = ExpressionValue("VAR/2")
         result = result.resolve(symbol_table)

diff --git a/test/virtualfiles/test_binary.py b/test/virtualfiles/test_binary.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.
@@ -97,6 +97,7 @@ def test_list_files_returns_empty_list(self):
         binary_file = BinaryFile()
         self.assertEqual([], binary_file.list_files())
 
+
 # M A I N #####################################################################
 
 if __name__ == '__main__':

diff --git a/test/virtualfiles/test_cassette.py b/test/virtualfiles/test_cassette.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/virtualfiles/test_coco_file.py b/test/virtualfiles/test_coco_file.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/virtualfiles/test_disk.py b/test/virtualfiles/test_disk.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.

diff --git a/test/virtualfiles/test_source_file.py b/test/virtualfiles/test_source_file.py
@@ -1,5 +1,5 @@
 """
-Copyright (C) 2022 Craig Thomas
+Copyright (C) 2013-2022 Craig Thomas
 
 This project uses an MIT style license - see LICENSE for details.
 A Color Computer Assembler - see the README.md file for details.