{"id":19373455,"url":"https://github.com/neo-project/specification","last_synced_at":"2025-02-24T14:48:45.371Z","repository":{"id":76869769,"uuid":"137170926","full_name":"neo-project/specification","owner":"neo-project","description":"NEO's formal specification","archived":false,"fork":false,"pushed_at":"2019-06-11T17:10:19.000Z","size":642,"stargazers_count":10,"open_issues_count":3,"forks_count":13,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-01-07T01:52:53.603Z","etag":null,"topics":["neo"],"latest_commit_sha":null,"homepage":null,"language":"TeX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-sa-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neo-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-13T06:17:37.000Z","updated_at":"2022-06-14T02:34:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"0f8dadd7-3bde-4787-ab65-f05c5bb24e9b","html_url":"https://github.com/neo-project/specification","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo-project%2Fspecification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo-project%2Fspecification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo-project%2Fspecification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neo-project%2Fspecification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neo-project","download_url":"https://codeload.github.com/neo-project/specification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240500710,"owners_count":19811561,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["neo"],"created_at":"2024-11-10T08:28:24.144Z","updated_at":"2025-02-24T14:48:45.336Z","avatar_url":"https://github.com/neo-project.png","language":"TeX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./doc-base/neo.png\" align=\"right\" height=\"70\"/\u003e\n\n# NEO Specification\n\n## Document format\nIn order to facilitate the contributions to the document, we decided to adopt pandoc format, which allows hybrid LaTeX + Markdown syntax.\n\n### Base structure\nThe structure of the document consists of five files:\n- specification.md : main document in Mardown + LaTeX (this file is automatically generated by `merge_sections.sh`)\n- [metadata.yaml](doc-base/metadata.yaml) : document metadata (authors, abstract, ...)\n- [style.pandoc](doc-base/style.pandoc) : document style (LaTeX headings)\n- [eisvogel.latex](doc-base/eisvogel.latex) : base LaTeX template (Eisvogel template with small changes)\n- [references.bib](doc-base/references.bib) : bibliography in BibTeX format\n\nThe sections are separated on `sections/` folder (these are used as source to generate `specification.md` file).\n\nCurrent draft proposal includes 6 sections + references (this may be changed by community, as anything else!):\n- [Introduction.md](sections/Introduction.md) : expected release date -\u003e Q2+ 2019\n- [Network.md](sections/Network.md) : expected release date -\u003e Q4+ 2019\n- [Numbers.md](sections/Numbers.md) : expected release date -\u003e Q3+ 2019\n- [Cryptography.md](sections/Cryptography.md) : expected release date -\u003e Q4+ 2019\n- [NeoVM.md](sections/NeoVM.md) : expected release date -\u003e Q3+ 2019\n- [NeoContract.md](sections/NeoContract.md) : expected release date -\u003e Q4+ 2019\n- [Consensus.md](sections/Consensus.md) : first released 14 March, 2019.\n- References (automatically generated from [references.bib](doc-base/references.bib)): expected release date -\u003e Q2+ 2019\n\n\n## Build instructions (manual build)\nInstall pandoc and LaTeX base (try [pandoc](https://pandoc.org/try)). On debian-based linux, you can simply run `make install`, and all dependencies will be installed.\n\nAfter pandoc and LaTeX base are available, you can simply run `make`, which will generate the specification paper pdf.\n\n### Building specific section\nAny section can be build using command `make section` and passing `SECTION` parameter.\nFor example: `make section SECTION=Consensus` will build section 08 (it will be stored on `build/Consensus.pdf`).\n\n## Automatically building using docker\nThe easiest way to build is by using docker.\n\n* Build the docker image using `docker_build.sh`\n\n* Compile the specification paper using `docker_run.sh`\n\n* Output will be generated as `build/neo-specification.pdf`\n\n## How to contribute\nIf you know Neo technology and want to contribute, feel free to directly submit a Pull Request with the desired changes.\nInitially, the idea is to create a broad and complete initial version of the document, which will be polished in the future.\n\n## License\n\nThis repository is Free Culture license Creative Commons 4.0 International (CC BY 4.0) for all figures and externally copyrighted material.\nAs usual, every author shall keep the copyright of its own contribution and agree with the CC BY 4.0 license for the combined work.\n\nPlease, when contributing, be careful to only add figures covered by Creative Commons licenses, and give proper references to original sources.\nWhen adding new original material to this project, contributor agrees that it will be covered by Free Culture license Creative Commons [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).\n\nThe beautiful Pandoc/LaTeX template [Eisvogel](https://github.com/Wandmalfarbe/pandoc-latex-template/) is licensed by BSD 3-Clause License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneo-project%2Fspecification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneo-project%2Fspecification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneo-project%2Fspecification/lists"}