Readme: hyperref, update how to build. Requires #433. #434
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,13 +5,25 @@ | |
|
|
||
| The Yellow Paper is a formal definition of the Ethereum protocol, originally by Gavin Wood, currently maintained by Nick Savers and with contributions from many people around the world. | ||
|
|
||
| It is a free culture work, licensed under Creative Commons Attribution Share-Alike (CC-BY-SA) version 4.0. | ||
|
|
||
| ## Usage | ||
|
|
||
| The latest version is generally available as a PDF at https://ethereum.github.io/yellowpaper/paper.pdf. With the hyperref package, this version of the yellow paper can be used to get links that direct to specific info in the yellow paper, which is useful e.g. for pedagogical and academic purposes. | ||
|
There was a problem hiding this comment. The new sentence is not descriptive enough. After reading it, I don't know how to obtain the link URL. There was a problem hiding this comment. I was going to add a link to the file that is added with #433. "For further info, see |
||
|
|
||
| How to build | ||
| --- | ||
|
There was a problem hiding this comment. The other headers use another style: |
||
|
|
||
| The paper also comes as a single ``latex`` file ``Paper.tex``, which is built as a PDF as follows. | ||
|
|
||
| ``` | ||
| git clone https://github.com/ethereum/yellowpaper.git | ||
| cd yellowpaper | ||
| ./build.sh | ||
| ``` | ||
| This will create a PDF version of the Yellow Paper. Following building, you can also use standard `pdflatex` tools like http://latex.informatik.uni-halle.de/latex-online/latex.php for compiling/preview. | ||
|
|
||
| ## Other language versions | ||
| - [Chinese](https://github.com/yuange1024/ethereum_yellowpaper) translated by YuanGe and GaoTianlu. | ||
|
|
||
|
|
||
|
There was a problem hiding this comment. This part needs not be changed. There was a problem hiding this comment. Oh, I didn't realise that I'd changed it. |
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change is irrelevant to this PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#447