Skip to content

Commit 36cd3ac

Browse files
authored
Update README.md
1 parent f5769fd commit 36cd3ac

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ chmod +x ./danac.sh
7272
```
7373

7474
The main frontend is `danac`.
75-
For convenience, we provide [`danac.sh`](./compiler/danac.sh) which automates IR generation, optimization, and linking.
75+
For convenience, we provide [`danac.sh`](./compiler/danac.sh), which automates IR generation, optimization, and linking.
7676

7777
### Basic Example
7878

@@ -109,9 +109,9 @@ Usage:
109109

110110
## Dana Runtime Library
111111

112-
Dana built-ins (`writeString`, `readInteger`, etc.) are implemented in C (`/llvm/dana_runtime.c`).
112+
Dana built-ins (`writeString`, `readInteger`, etc.) are implemented in C (`/compiler/dana_runtime.c`).
113113

114-
Build the runtime:
114+
We built the runtime with:
115115

116116
```bash
117117
gcc -c dana_runtime.c -o dana_runtime.o
@@ -135,7 +135,7 @@ Each compiler stage lives in its own subdirectory with a dedicated README:
135135

136136
Additional documentation:
137137

138-
* [LLVM IR Optimization](OPTIMISATIONS.md) – explains our optimization pipeline, levels, and LLVM passes used.
138+
* [LLVM IR Optimization](OPTIMISATIONS.md) – explains our optimization pipeline, levels, and LLVM passes used in the final compiler.
139139
* [Projects](PROJECTS.md) – analysis of large/complex Dana programs in `testing/extra-hard/`.
140140

141141
---
@@ -144,10 +144,10 @@ Additional documentation:
144144

145145
The repository includes a full Python test framework in `testing/`.
146146

147-
* **Lexer tests** `python3 testing/test_lexer.py`
148-
* **Parser tests** `python3 testing/test_parser.py`
149-
* **Semantic tests** `python3 testing/test_semantic.py`
150-
* **LLVM tests** `python3 testing/test_llvm.py`
147+
* **Lexer tests** → `python3 testing/test_lexer.py`
148+
* **Parser tests** → `python3 testing/test_parser.py`
149+
* **Semantic tests** → `python3 testing/test_semantic.py`
150+
* **LLVM tests** → `python3 testing/test_llvm.py`
151151

152152
The **end-to-end compiler test** (`python3 testing/test_compiler.py`) does the following:
153153

@@ -169,11 +169,11 @@ These are analyzed in detail in [PROJECTS.md](PROJECTS.md).
169169

170170
GitHub Actions run tests on every push/PR:
171171

172-
* `lexer.yml` runs lexer tests
173-
* `parser.yml` runs parser tests
174-
* `semantic.yml` runs semantic tests
175-
* `llvm.yml` builds LLVM backend and runs tests (LLVM 14)
176-
* `compiler.yml` builds full compiler and runs all tests
172+
* `lexer.yml` → runs lexer tests
173+
* `parser.yml` → runs parser tests
174+
* `semantic.yml` → runs semantic tests
175+
* `llvm.yml` → builds LLVM backend and runs tests (LLVM 14)
176+
* `compiler.yml` → builds full compiler and runs all tests
177177

178178
---
179179

0 commit comments

Comments
 (0)