Skip to content

Commit 773407a

Browse files
committed
The changes in this commit primarily focus on fixing Markdown links, minor grammatical errors, and some stylistic improvements in the documentation for a virtual machine (MVM) assembly language.
* **Markdown Links Corrected:** Numerous Markdown links throughout the documentation have been updated to use the `.md` extension. This ensures that links resolve correctly when rendered using a Markdown processor. Affected files include `_Sidebar.md`, `Home.md`, `Getting-Started.md`, `Assembly-Intro.md`, `Registers.md`, `Memory-Model.md`, `Standard-Library.md`, `System-Calls.md`, `Virtual-Devices.md`, `Instruction-Set.md`, and `Future-Plans.md`. * **Grammatical Fixes:** Minor grammatical errors have been corrected, such as changing "are stored" to "is stored" in `System-Call-Implementation.md`. The term "Maths" has been changed to the British English spelling "Maths" in `Standard-Library.md`. American English spelling "Personalized" has been changed to British English spelling "Personalised" in `Future-Plans.md`. Use of analyze vs analyse (American vs British english) * **Stylistic Changes:** Some stylistic changes have been made to improve readability. For example, extraneous backticks have been removed from code examples in `Instruction-Set.md`. Unnecessary trailing spaces and a trailing ``` in `System-Call-Implementation.md` have been removed. Blank lines and indentation have been adjusted in `Memory-Model.md`. Comments markers have been changed from `;` to `//` in `Instruction-Set.md`. * **Content Changes:** A small content change was made to the return value description in `System-Call-Implementation.md` to reflect stack management by the VM's runtime. Word repetition removed. Redundant explanations in `Instruction-Set.md` removed. Removed `INR` and `DEALLOC` instructions. Removed some IDE-specific configuration changes in `.idea/misc.xml` and `.idea/inspectionProfiles/Project_Default.xml`. In summary, these changes enhance the documentation's clarity, consistency, and correctness, making it more accessible and useful for users learning about the MVM assembly language. They do not introduce new functionality or alter the behavior of the MVM itself.
1 parent a678a95 commit 773407a

14 files changed

+131
-217
lines changed

.idea/inspectionProfiles/Project_Default.xml

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/misc.xml

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/Assembly-Intro.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ PRINTR R1 // Print the value in R4 (15)
4949

5050
For detailed information, refer to:
5151

52-
* [Instruction Set](Instruction-Set): Detailed explanation of each instruction.
53-
* [Registers](Registers): Information on the different register types.
54-
* [Memory Model](Memory-Model): How memory is organised and accessed.
55-
* [System Calls](System-Calls): How to interact with the OS kernel.
56-
* [Standard Library](Standard-Library): Overview of available functions.
52+
* [Instruction Set](Instruction-Set.md): Detailed explanation of each instruction.
53+
* [Registers](Registers.md): Information on the different register types.
54+
* [Memory Model](Memory-Model.md): How memory is organised and accessed.
55+
* [System Calls](System-Calls.md): How to interact with the OS kernel.
56+
* [Standard Library](Standard-Library.md): Overview of available functions.
5757

5858
This introduction provides a foundation for understanding the MVM assembly language. You can start writing programs
5959
after

docs/Future-Plans.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
## I. Language and Runtime Enhancements
44

55
1. **Customizable Syntax:** Allow users to define their own syntax for MVM assembly language, enabling domain-specific
6-
languages or personalized coding styles.
6+
languages or personalised coding styles.
77
2. **Built-in Data Structures:** Implement built-in support for more complex data structures like hash maps, trees, and
88
graphs, accessible through standard library functions or new instructions.
99
3. **Type Inference:** Add type inference to your higher-level language (if you create one), reducing the need for
1010
explicit type declarations.
11-
4. **Automatic Memory Management:** Explore garbage collection algorithms (mark-and-sweep, reference counting) to
11+
4. **Automatic Memory Management:** Explore garbage collection algorithms (mark-and-sweep, reference counting) to
1212
automate memory management and prevent memory leaks.
13-
5. **Reflection API:** Allow programs running in the VM to inspect and manipulate their own structure and behavior (
13+
5. **Reflection API:** Allow programs running on the VM to inspect and manipulate their own structure and behaviour (
1414
e.g., access register values, inspect the call stack).
1515
6. **Dynamic Linking:** Enable dynamic linking of libraries or modules, allowing programs to load and use external code
1616
at runtime.
@@ -40,8 +40,8 @@
4040

4141
## IV. Debugging and Development Tools
4242

43-
17. **Time-Travel Debugging:** Implement a debugger that allows stepping backward through program execution to analyze
44-
program behavior.
43+
17. **Time-Travel Debugging:** Implement a debugger that allows stepping backward through program execution to analyse
44+
program behaviour.
4545
18. **Code Coverage Analysis:** Add tools to measure code coverage during testing.
4646
19. **Performance Profiler:** Develop tools to profile CPU usage, memory access patterns, and other performance metrics.
4747
20. **Bytecode Disassembler:** Create a tool to disassemble MVM bytecode back into assembly language for easier
@@ -63,6 +63,6 @@
6363
execution environment (interesting for simulations or genetic algorithms).
6464
27. **MVM as a Service:** Create a web service that allows users to upload and run MVM programs remotely.
6565

66-
This document details planned enhancements for the MVM. This is a high-level view, and the prioritization and specifics
66+
This document details planned enhancements for the MVM. This is a high-level view, and the prioritisation and specifics
6767
are subject to change.
6868

docs/Getting-Started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ call println // Prints the string located in F1 to stdout
8686
To run this program, use one of the above commands, replacing `<path_to_assembly_file.kar>` with `myprogram.kar`. The
8787
output will be printed to the console.
8888

89-
Now you can start writing and executing your own assembly programs. Refer to the [Instruction Table](Instruction-Table)
89+
Now you can start writing and executing your own assembly programs. Refer to
90+
the [Instruction Table](Instruction-Table.md)
9091
for a list of instructions and their syntax.
9192

docs/Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ rewrite focuses on simulating a time-sharing operating system kernel within the
3232
## Getting Started
3333

3434
For detailed instructions on setting up and running the virtual machine, please refer to
35-
the [Installation and Setup](Getting-Started) guide.
35+
the [Installation and Setup](Getting-Started.md) guide.
3636

3737
## Explore the Documentation
3838

0 commit comments

Comments
 (0)