From a3ad118fe29129ede02fb0ef2c9171834345e6f4 Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Mon, 29 Jul 2019 09:31:06 +0200 Subject: [PATCH] Merge PR #154: Add basic PDF w/line numbers --- Makefile | 5 +++- README.md | 2 ++ spec.pdc | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ spec.pdf | Bin 0 -> 131 bytes 4 files changed, 78 insertions(+), 1 deletion(-) create mode 100644 spec.pdc create mode 100644 spec.pdf diff --git a/Makefile b/Makefile index ee9084fc9..5fe8bbacf 100644 --- a/Makefile +++ b/Makefile @@ -19,4 +19,7 @@ check_syntax: check_sections: python ./scripts/check_sections.py -.PHONY: $(TOPTARGETS) $(SUBDIRS) check check_links check_dependencies check_syntax check_sections +spec_pdf: + pandoc --pdf-engine=xelatex --template eisvogel --filter pandoc-include --mathjax --toc --number-sections -o spec.pdf spec.pdc + +.PHONY: $(TOPTARGETS) $(SUBDIRS) check check_links check_dependencies check_syntax check_sections spec_pdf diff --git a/README.md b/README.md index 7f29cb915..fc8dfb76f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ To propose a new standard, [open an issue](https://github.com/cosmos/ics/issues/ See [PROCESS.md](PROCESS.md) for a description of the standardization process. +Quick references & interchain standards can be read as [a single PDF](./spec.pdf). + ## IBC Quick References The subject of most initial interchain standards is the inter-blockchain communication protocol, "IBC". diff --git a/spec.pdc b/spec.pdc new file mode 100644 index 000000000..7373ddb59 --- /dev/null +++ b/spec.pdc @@ -0,0 +1,72 @@ +--- +title: The Interblockchain Communication Protocol +lang: en-GB +titlepage: true +titlepage-color: "06386e" +titlepage-text-color: "FFFFFF" +titlepage-rule-color: "FFFFFF" +titlepage-rule-height: 1 +toc-own-page: true +mainfont: DejaVuSerifCondensed +fontsize: 7pt +author: IBC Specification Team +date: \today \ - \textbf{1.0.0-rc0} +urlcolor: cyan +header-includes: + - \usepackage{graphicx} + - \usepackage{hyperref} + - \usepackage[left]{lineno} + - \linenumbers +--- + +\pagebreak + +!include ibc/1_IBC_ARCHITECTURE.md + +!include ibc/2_IBC_DESIGN_PRINCIPLES.md + +!include ibc/3_IBC_TERMINOLOGY.md + +!include ibc/4_IBC_USECASES.md + +!include ibc/5_IBC_DESIGN_PATTERNS.md + +# ICS 001 - ICS Standard + +!include spec/ics-001-ics-standard/README.md + +# ICS 002 - Consensus Verification + +!include spec/ics-002-consensus-verification/README.md + +# ICS 003 - Connection Semantics + +!include spec/ics-003-connection-semantics/README.md + +# ICS 004 - Channel & Packet Semantics + +!include spec/ics-004-channel-and-packet-semantics/README.md + +# ICS 005 - Port Allocation + +!include spec/ics-005-port-allocation/README.md + +# ICS 018 - Relayer Algorithms + +!include spec/ics-018-relayer-algorithms/README.md + +# ICS 023 - Vector Commitments + +!include spec/ics-023-vector-commitments/README.md + +# ICS 024 - Host Requirements + +!include spec/ics-024-host-requirements/README.md + +# ICS 025 - Handler Interface + +!include spec/ics-025-handler-interface/README.md + +# ICS 026 - Relayer Module + +!include spec/ics-026-relayer-module/README.md diff --git a/spec.pdf b/spec.pdf new file mode 100644 index 0000000000000000000000000000000000000000..67689582a0aeeb6b163e4e3329035de3c42f3be3 GIT binary patch literal 131 zcmWN?K@!3s3;@78uiyig5=toj4J1LBQRxWw;OliSd&zsW{?c{Ma~#Ip+q^x>SpL^f zUZ_9KIEBn*Rd1|EP2llx8JMsz7gzIX4RC~p7& literal 0 HcmV?d00001