-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
This reverts commit b391020.
- Loading branch information
1 parent
b391020
commit 30e72ea
Showing
36 changed files
with
5,804 additions
and
95 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
use flake .#spec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
/main.* | ||
!/main.tex | ||
/.auctex-auto/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Hydra Specification | ||
|
||
The Hydra Head protocol is specified in the single document built from this | ||
directory. | ||
|
||
We use LaTeX to write the specification and used to compose this on | ||
[overleaf](www.overleaf.com). Going forward, any changes to the specification | ||
should follow the common pull request rules as set out in our [contribution | ||
guidelines](../CONTRIBUTING.md). | ||
|
||
The [Overleaf documentation](https://www.overleaf.com/learn) does provide a good | ||
introduction to LaTeX syntax and functions to get started. | ||
|
||
## Building | ||
|
||
You can use `nix` to build a PDF from the LaTeX files using | ||
|
||
``` shell | ||
nix build .#spec | ||
``` | ||
|
||
which will write the PDF into `result/hydra-spec.pdf`. | ||
|
||
Alternatively, you would need to have a LaTeX distribution installed (e.g. | ||
`texlive`) and produce a PDF output using `pdflatex` etc. The [LaTeX | ||
wikibook](https://en.wikibooks.org/wiki/LaTeX/Basics#Building_a_document) might | ||
be helpful to set things up. |
Oops, something went wrong.