a gleam implementation of a CS assignment originally written in cpp

docs: update readme

Changed files
+46 -9
+46 -9
README.md
···
# Lab 6
-
## Part 1
+
For this lab the program must parse `OT.txt` (format below) to find specific references and produce scoped errors if the reference isn't found.
-
Review the lab write-ups in ZyBooks for Section 6.6.
+
```text
+
THE BOOK OF GENESIS
-
Edit your code using vi.
+
CHAPTER 1
+
1 In the beginning God created the heaven and the earth.
+
2 And the earth was without form, and void; and darkness [was] upon the face of the deep. And the Spirit of God moved upon the face of the waters.
+
3 And God said, Let there be light: and there was light.
+
4 And God saw the light, that [it was] good: and God divided the light from the darkness.
-
Compile your code using:
+
THE BOOK OF PSALMS
+
+
PSALM 1
+
1 Blessed [is] the man that walketh not in the counsel of the ungodly, nor standeth in the way of sinners, nor sitteth in the seat of the scornful.
+
2 But his delight [is] in the law of the LORD; and in his law doth he meditate day and night.
+
3 And he shall be like a tree planted by the rivers of water, that bringeth forth his fruit in his season; his leaf also shall not wither; and whatsoever he doeth shall prosper.
+
```
+
+
The project is layed out as follows:
```bash
-
g++ lab66.cpp -o lab66
+
.
+
├── build # this directory isn't committed and is ephemeral
+
│   └── lab66
+
├── COVERSHEET.md
+
├── LICENSE.md
+
├── makefile
+
├── README.md
+
├── src
+
│   └── lab66.cpp
+
└── test
+
├── OT.txt
+
└── test.sh
+
+
4 directories, 8 files
```
-
## Part 2
+
### Build scripts
+
+
The preferred way to run the program is through make:
-
Complete the [Coversheet](coversheet.md) file and submit it with your final solution
+
```bash
+
make # compiles and runs tests
+
make run # compiles and runs the program
+
make clean # clean up the build dir
+
```
-
## Part 3
+
it is however possible to still do things manually:
-
Ensure all code is committed and pushed to GitHub along with running it in ZyLabs.
+
```bash
+
mkdir build
+
cd build
+
g++ ../src/lab66.cpp -o lab66
+
./lab66 ../test/OT.txt verses.txt
+
```
<p align="center">
<img src="https://raw.githubusercontent.com/taciturnaxolotl/carriage/main/.github/images/line-break.svg" />