Skip to content

Commit 022997a

Browse files
docs: minor touchups to README (python#49)
1 parent 837a1ea commit 022997a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This Orbital, we intend to refine pyLBBV. These include but are not limited to:
4545
- [X] Bug fixing
4646
- [X] A more advanced type propagator.
4747
- [X] A more comprehensive test suite with Continuous Integration testing.
48-
- [ ] A copy and patch JIT compiler.
48+
- [ ] A copy and patch JIT compiler. (Not yet implemented!)
4949

5050
A JIT(Just-in-Time) compiler is just a program that generates native machine executable code at runtime. [Copy and Patch](https://arxiv.org/abs/2011.13127) is a new fast compilation technique developed rather recently. The general idea is that compilation normally requires multiple steps, thus making compilation slow (recall how many steps your SICP meta-circular evaluator needs to execute JS)! Copy and patch makes compilation faster by skipping all the intermediate steps, and just creating "templates" for
5151
the final code. These "templates" are called *stencils* and they contain *holes*, i.e. missing values. All you have to do for compilation now is to copy and template, and patch in the holes. Thus making it very fast!
@@ -77,7 +77,7 @@ We did a major refactor of our code generation machinery. This makes the code ea
7777
##### SWE dev best practices and CI testing
7878

7979
- We have added both feature tests and regression tests to our test script in [tier2_test.py](./tier2_test.py).
80-
- We now have continous integration. We build our project and run tests using GitHub Actions for Windows 64-bit, on every pull request and commit to the repository!
80+
- We now have continous integration. We automatically build our project and run tests using GitHub Actions for Windows 64-bit, on every pull request and commit to the repository!
8181
![image](./orbital/CI.png)
8282
- All PRs require review and an approval before merging is allowed. All tests in CI must also pass. This follows standard best practices.
8383

0 commit comments

Comments
 (0)