GitList
Browse code

Add ROM and ASM to the README.md file

Pawel Jablonski authored on 23/12/2022 15:28:14
Showing 1 changed files
README.md
History View file @ 6efa3d4
... ... 
@@ -75,10 +75,10 @@ The project supports building process on Windows and Linux.
75 75
76 76 
 - Geany - Multi-language IDE. Used to create Makefile, assembler code etc.
77 77 
 - QtCreator - IDE for C++/Qt. Used to create desktop applications.
78 
-- Qt 5.12.8 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.
78 
+- Qt 5.12.4 - Multiplatform Qt 5 library. It supports UI, data structures, files etc.
79 79 
 - GCC - C and C++ code compiler.
80 80 
 - Make - Build automation tool.
81 
-- Doxygen 1.9.2 - Documentation generator from annotated sources.
81 
+- Doxygen 1.9.5 - Documentation generator from annotated sources.
82 82 
 - Proteus 8 - Circuit simulator software. Used to simulate the XiPU.
83 83 
 - QCAD - DXF files editor. Used to create Plexiglas case for the XiPC.
84 84
... ... 
@@ -86,11 +86,13 @@ The project supports building process on Windows and Linux.
86 86
87 87 
 ```console
88 88 
 .
89 
+├── asm            # Assembler Compiler for the XiPU.
89 90 
 ├── case           # A simple Plexiglas case project for the XiPC.
90 91 
 ├── ide
91 92 
 │   ├── geany      # IDE configuration to support assembler for the XiPU.
92 93 
 │   └── qtcreator  # IDE configuration for code rules.
93 94 
 ├── lib            # Binary libraries needed to run compiled applications on Windows.
95 
+├── rom            # OS with a simple terminal and IO API for applications.
94 96 
 ├── sim            # Simulation project of the XiPU.
95 97 
 └── urom
96 98 
     ├── doc        # Documentation of the uROM generator to make by Doxygen.
... ... 
@@ -120,9 +122,44 @@ Or on Linux:
120 122 
 ./urom
121 123 
 ```
122 124
125 
+### ROM
123 126
127 
+To build the OS ROM image file, the map file with API handlers, and create documentation, please type:
124 128
129 
+```console
130 
+cd rom
131 
+make
132 
+```
133 
+
134 
+### ASM
135 
+
136 
+To build the application and create documentation, please type:
137 
+
138 
+```console
139 
+cd asm
140 
+make
141 
+```
142 
+
143 
+To compile ROM, please type on Windows:
144 
+
145 
+```console
146 
+./asm.exe rom [input_file] [output_bin] [output_map]
147 
+```
148 
+
149 
+Or on Linux:
150 
+
151 
+```console
152 
+./asm rom [input_file] [output_bin] [output_map]
153 
+```
125 154
155 
+To compile an application, please type on Windows:
126 156
157 
+```console
158 
+./asm.exe app [input_file] [output_bin]
159 
+```
127 160
161 
+Or on Linux:
128 162
163 
+```console
164 
+./asm app [input_file] [output_bin]
165 
+```