Update readme, add flowcharts

Author: YJDoc2

README.md

@@ -47,7 +47,7 @@ As this is not on crates.io, dependency is specified using this repository itsel
 
 ```TOML
 [dependencies]
-emulator_8086_lib = { git = "https://github.com/YJDoc2/8086-Emulator" }
+emulator_8086 = { git = "https://github.com/YJDoc2/8086-Emulator" }
 ```
 
 This will allow to import and use the core library of this in your project :
@@ -67,7 +67,7 @@ or use it under different name :
 ```TOML
 ...
 [dependencies]
-a_different_name = { git = "https://github.com/YJDoc2/8086-Emulator" }
+a_different_name = { git = "https://github.com/YJDoc2/8086-Emulator", package="emulator_8086"}
 ...
 ```
 
@@ -127,6 +127,7 @@ The complete project has following file structure :
 ├── LICENSE-APACHE        -> Licence file
 ├── LICENCE-MIT           -> Licence file
 ├── syntax.md             -> file containing syntax for the assembler
+├── flowcharts.md         -> Markdown file containing flowcharts for various parts of emulator
 └── .gitignore            -> gitignore file for the repository
 ```
 
@@ -151,6 +152,8 @@ The flow of the complete process is :
 - The driver checks for errors, start labels, and if all labels that are used before declaration (in jump commands) are declared or not. Then it gives data list of preprocessor output to data parser, which interprets data commands and stores the data into vm's memory
 - The driver checks for errors and runs an unconditional loop, in which it gives the code instructions to interpreter, checks its return state, and accordingly gives next input. If it is run in interpreted mode / encounters int 3 or trap flag is set, it also provides user prompt and interprets and runs print commands. Driver also has responsibility to handle DOS and BIOS interrupts.
 
+Flowcharts for various parts of emulator are in the [flowcharts.md](./flowcharts.md) file.
+
 ---
 
 ## License

examples/hello_world.s

@@ -0,0 +1,13 @@
+; Program to show use of interrupts
+; Also, Hello World program !
+hello: DB "Hello World" ; store string
+
+; actual entry point of the program, must be present
+start:
+MOV AH, 0x13            ; move BIOS interrupt number in AH
+MOV CX, 11              ; move length of string in cx
+MOV BX, 0               ; mov 0 to bx, so we can move it to es
+MOV ES, BX              ; move segment start of string to es, 0
+MOV BP, OFFSET hello    ; move start offset of string in bp
+MOV DL, 0               ; start writing from col 0
+int 0x10                ; BIOS interrupt

flowcharts.md

@@ -0,0 +1,55 @@
+```mermaid
+graph TD
+subgraph Overall Flowchart
+    start([Start])-->read
+    read[Read Code]-->preprocess
+    preprocess[Process code in Preprocessor]-->|Data instruction|data
+    preprocess[Process code in Preprocessor]-->|Code instruction|driver
+    data[For each instruction]-->data_processor
+    data_processor[Input instruction to data processor]-->data
+    driver[Driver]-->instr
+    instr[Input instruction to Interpreter]-->status
+    status[Get Status code]-->status_action
+    status_action[Take appropriate action]-->instr
+    status_action[Take appropriate action]-->|Error|error
+    error[Display Error Information]-->halt
+    status_action[Take appropriate action]-->|Halt instruction|halt
+    halt[Stop the emulator]
+end
+```
+
+```mermaid
+graph TD
+subgraph Interpreter Process Flowchart
+    start([Start])-->instr_command
+    instr_command[Parse Instruction Command]-->action
+    action[Take appropriate Action]-->return
+    return([Return Status Value])
+end
+```
+
+```mermaid
+graph TD
+subgraph Data Process Flowchart
+    start([Start])-->data_command
+    data_command[Parse Data command]-->action
+    action[Store Data in memory accordingly]-->return
+    return([Return])
+end
+```
+
+```mermaid
+graph TD
+subgraph Preprocess Flowchart
+    start([Start])-->input
+    input(User Enters Code)-->|preprocess|case
+    case[Make the case Uniform and parse numbers]-->labels
+    labels[Process and store label locations]-->macro
+    macro[Replace and process <br/>macro declaration and invocation]-->function
+    function[Process and store function locations]-->verify
+    verify[Verify syntax]-->|IR|split
+    verify[Verify syntax]-->|error|error([Return Error])
+    split[Split data and program instructions]-->return
+    return([Return Data and Code instructions <br/> Along with context information])
+end
+```