Skip to content

Commit 7e4f3fa

Browse files
committed
Add README
1 parent 79f3fda commit 7e4f3fa

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# hw02
2+
3+
This repository contains some minimal starter files for Homework Assignment 2.
4+
5+
```
6+
.
7+
├── Makefile a minimal Makefile for your convenience
8+
├── hw02-student.pdf built from hw02-student.tex
9+
├── hw02-student.tex a LaTeX template for your submission (if you wish)
10+
├── hw02.pdf assignment handout
11+
└── ocaml lab files
12+
```
13+
14+
Please make sure you have built the `pdf` from your `tex` file for your final submission.

ocaml/README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# hw02/ocaml
2+
3+
This repository contains some minimal OCaml starter files for Homework Assignment 2.
4+
5+
```
6+
.
7+
├── hw02.ml a template for your submission (if you wish)
8+
├── hw02.sh a minimal script to run tests
9+
└── test_hw02.ml a template for your tests (if you wish)
10+
```
11+
12+
1 directory, 6 files
13+
14+
## Dependencies
15+
16+
First, make sure you have `ocaml` and `opam` installed from your system's package manager. Then, you can install the build and library dependencies as follows:
17+
18+
```
19+
opam install dune base ounit2
20+
```
21+
22+
## Build and Run Tests
23+
24+
You can build and run tests as follows:
25+
26+
```
27+
dune runtest
28+
```
29+
30+
Or, the simple top-level script
31+
32+
```
33+
./hw02.sh
34+
```
35+
36+
simply calls the above.

0 commit comments

Comments
 (0)