Skip to content

Commit

Permalink
docs: mention new GH-Pages deployment in README
Browse files Browse the repository at this point in the history
Before merging #255, the gh-pages branch of this repository was used
for our live API reference instance. Unfortunately, that branch houses
multiple binaries which were rebuilt on every-push, leading to the
branch growing in-size without bound, and dramatically increasing the
storage and network burden for all clones and forks.

Following #255 and the deletion of the gh-pages branch, the repo can
be cloned almost instantly, and the burden is fully offloaded to a
second repository which no one should need to clone under normal
circumstances.

This commit simply adds reference to the new deployment (since GH's
web interface is not smart enough to link to the external repo
automatically).

Signed-off-by: Sam Stuewe <stuewe@mit.edu>
  • Loading branch information
HalosGhost committed Apr 23, 2024
1 parent 8aefd51 commit 45b07e4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ Note that if you have not already installed the xcode cli tools you will need to
```
# Run the Code

The API Reference is now housed in [an external repository](https://github.com/mit-dci/opencbdc-tx-pages/).
See the [live deployment](https://mit-dci.github.io/opencbdc-tx-pages/) to browse.

## UHS-based Architectures (2PC & Atomizer)
See the [2PC & Atomizer User Guide](docs/2pc_atomizer_user_guide.md)
## PArSEC Architecture
Expand Down

0 comments on commit 45b07e4

Please sign in to comment.