diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 3 insertions, 5 deletions
@@ -15,17 +15,15 @@ While files generated by emulator dump scripts should provide as much informatio ## **Reading the Specification Documentation** -The specification documentation can be found at `docs/latest/draft-tasd-spec.html`, `docs/latest/draft-tasd-0001.pdf`, and `docs/latest/draft-tasd-0001.txt` and is presented in a format quite similar to IETF (Internet Engineering Task Force) RFC (Request For Comment) documents. +The specification documentation can be found at `docs/latest/draft-tasd-spec.html`, and `docs/latest/draft-tasd-0001.txt` and is presented in a format quite similar to IETF (Internet Engineering Task Force) RFC (Request For Comment) documents. ## **Building the Specification Documentation** ### Documentation Build Dependencies - xml2rfc - + pango (for PDF build support) - + weasyprint (for PDF build support) -All 3 dependencies can be installed from the Python3 PIP package manager. +All Dependencies can be installed from the Python3 PIP package manager. ### Build the Documentation From a terminal, go to the the main directory of this project (the directory this README.md file exists in). You can then build the NES ROM with the following command. @@ -34,7 +32,7 @@ From a terminal, go to the the main directory of this project (the directory thi make ``` -After building the documentation, you should find `draft-tasd-0001.html`, `draft-tasd-0001.pdf`, and `draft-tasd-0001.txt` in the `build/docs/` directory. +After building the documentation, you should find `draft-tasd-0001.html`, and `draft-tasd-0001.txt` in the `build/docs/` directory. The source code for the documentation can be found in `src/docs/draft-tasd-0001.xml`. The xml2rfc vocabulary of the xml file is explained in [RFC 7991](https://www.rfc-editor.org/rfc/rfc7991). |