Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanuppal committed Apr 14, 2024
1 parent 9b286de commit 861b06c
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ build:
opam exec -- dune build
@cp _build/install/default/bin/cs3110_compiler ./main
@chmod u+x ./main
@chmod u+x .githooks/pre-commit
@make README

.PHONY: README
Expand All @@ -16,6 +17,7 @@ README:
test: build
opam exec -- dune test

.PHONY: bisect
bisect:
@find . -name '*.coverage' | xargs rm -f
@OUNIT_CI=true dune test --instrument-with bisect_ppx --force
Expand All @@ -25,6 +27,7 @@ bisect:
cat _coverage/index.html | pup html body div#header h2 text{}; \
fi

.PHONY: view
view:
open _coverage/index.html

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
<!-- THIS FILE IS GENERATED AUTOMATICALLY. -->
<!-- DO NOT EDIT THIS FILE. -->
<!-- EDIT README.md.template INSTEAD. -->
# cs3110_compiler
# x86ISTMB v0.1.0


![CI Status](https://github.com/ethanuppal/cs3110_compiler/actions/workflows/ci.yaml/badge.svg)

Last updated: 2024-04-14 02:04:28.457230
> "x86 is simple trust me bro"
> Last updated: 2024-04-14 02:11:53.568813
```
$ ./main -h
Expand Down
5 changes: 3 additions & 2 deletions README.md.template
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# cs3110_compiler
# x86ISTMB {{VERSION_NUM}}

![CI Status](https://github.com/ethanuppal/cs3110_compiler/actions/workflows/ci.yaml/badge.svg)

Last updated: {{DATE}}
> "x86 is simple trust me bro"
> Last updated: {{DATE}}

```
$ ./main -h
Expand Down
9 changes: 8 additions & 1 deletion readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@ def put(var, text):
put("HELP", subprocess.check_output(["./main", "-h"], text=True))
put("VERSION", subprocess.check_output(["./main", "-v"], text=True))
put("DATE", str(dt.now()))

put(
"VERSION_NUM",
subprocess.check_output(
"ocaml -e '#use \"./lib/meta.ml\";; print_endline (Version.to_string get.version)'",
shell=True,
text=True,
),
)
with open("README.md", "w") as f:
f.write(
"<!-- THIS FILE IS GENERATED AUTOMATICALLY. -->\n<!-- DO NOT EDIT THIS FILE. -->\n<!-- EDIT README.md.template INSTEAD. -->\n"
Expand Down

0 comments on commit 861b06c

Please sign in to comment.