From 833daa0bcffa8982be24e2166cef2f4ac3a4dc7f Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Sat, 20 Jan 2018 18:38:17 +1100 Subject: [PATCH 1/7] Readme: hyperref, update how to build --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 709555e5..29027284 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,26 @@ 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 free culture work, licensed under the Creative Commons Attribution Share-Alike (CC-BY-SA) version 4.0. +It is a free culture work, licensed under Creative Commons Attribution Share-Alike (CC-BY-SA) version 4.0. ## Usage -The paper comes as a single ``latex`` file ``Paper.tex``. The latest version is generally available as a PDF at https://ethereum.github.io/yellowpaper/paper.pdf or just [yellowpaper.io](http://yellowpaper.io/) . +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. [Here]( +https://github.com/ethereum/yellowpaper/files/1596574/Paper.pdf#blockhash) is an example of such a use. -In order to build, use the supplied build script (``build.sh``). Following the first time, you can use the standard `pdflatex` tools like http://latex.informatik.uni-halle.de/latex-online/latex.php for compiling/preview. It can be viewed in ``PDF`` format after building. +How to build +--- + +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 +- [Chinese](https://github.com/yuange1024/ethereum_yellowpaper) translated by YuanGe and GaoTianlu. + + From 8231fc79a08b106fa39948c4b494c20fbd661770 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Sat, 20 Jan 2018 22:37:21 +1100 Subject: [PATCH 2/7] Remove a link with an older version of the PDF An alternative is to link to the file created by #433. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 29027284..cb1ef3c5 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ It is a free culture work, licensed under Creative Commons Attribution Share-Ali ## 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. [Here]( -https://github.com/ethereum/yellowpaper/files/1596574/Paper.pdf#blockhash) is an example of such a use. +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. How to build --- From 9ee13ad4eb6aaa2333a6a75189db663fd05f1a3a Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Mon, 22 Jan 2018 23:43:01 +1100 Subject: [PATCH 3/7] Revert grammar changes back to previous --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cb1ef3c5..e5dbf101 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 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. +It is free culture work, licensed under the Creative Commons Attribution Share-Alike (CC-BY-SA) version 4.0. ## Usage From 687b218b005e6453136d65d2663fc1aa208f8251 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Mon, 22 Jan 2018 23:44:21 +1100 Subject: [PATCH 4/7] Change style of header for consistency --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index e5dbf101..62f1a6fc 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,7 @@ It is free culture work, licensed under the Creative Commons Attribution Share-A 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. -How to build ---- +## How to build The paper also comes as a single ``latex`` file ``Paper.tex``, which is built as a PDF as follows. From 8f1c49517a3cb0b8962fa3f84c4d6b9dfa694847 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Mon, 22 Jan 2018 23:45:24 +1100 Subject: [PATCH 5/7] Remove redundant lines --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 62f1a6fc..9a891b9e 100644 --- a/README.md +++ b/README.md @@ -24,5 +24,3 @@ This will create a PDF version of the Yellow Paper. Following building, you can ## Other language versions - [Chinese](https://github.com/yuange1024/ethereum_yellowpaper) translated by YuanGe and GaoTianlu. - - From a779ccb1d9201fc0889aa0f0f5d3c6d488c636a8 Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Mon, 22 Jan 2018 23:46:44 +1100 Subject: [PATCH 6/7] Remove a period to another PR #447 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a891b9e..4f01c581 100644 --- a/README.md +++ b/README.md @@ -23,4 +23,4 @@ cd yellowpaper 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. +- [Chinese](https://github.com/yuange1024/ethereum_yellowpaper) translated by YuanGe and GaoTianlu From d5ae46e47bb63741d37e781fa2a8b46a3db52d4c Mon Sep 17 00:00:00 2001 From: James Ray <16969914+jamesray1@users.noreply.github.com> Date: Mon, 22 Jan 2018 23:52:56 +1100 Subject: [PATCH 7/7] Revert how to build to original, move change to #448 --- README.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/README.md b/README.md index 4f01c581..dd7b204c 100644 --- a/README.md +++ b/README.md @@ -11,16 +11,7 @@ It is free culture work, licensed under the Creative Commons Attribution Share-A 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. -## How to build - -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. +In order to build, use the supplied build script (``build.sh``). Following the first time, you can use the standard `pdflatex` tools like http://latex.informatik.uni-halle.de/latex-online/latex.php for compiling/preview. It can be viewed in ``PDF`` format after building. ## Other language versions - [Chinese](https://github.com/yuange1024/ethereum_yellowpaper) translated by YuanGe and GaoTianlu