summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorbigbass1997 <bigbass1997.website@gmail.com>2025-04-16 21:49:22 -0500
committerbigbass1997 <bigbass1997.website@gmail.com>2025-04-16 21:49:22 -0500
commit0fb57077015001af4063a20cf8db4ce4fbf7fffc (patch)
treed053b4cf6e8933007e42bd3d69d13f46b0dda56d /CONTRIBUTING.md
parentb7e8e3d85af8dd84ee9f1c523bdd3d986b64e3d3 (diff)
downloadtasd-0fb57077015001af4063a20cf8db4ce4fbf7fffc.tar.gz
tasd-0fb57077015001af4063a20cf8db4ce4fbf7fffc.zip
Move toward a release file structure. Remove outdated tools (will be readded to a different repo).
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md31
1 files changed, 26 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 92a5978..fb7f024 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,27 @@
-If you wish to contribute to this project, please be aware of and follow these rules.
+## Contribution
+If you wish to contribute to this project, please be aware of and follow these rules:
+* If you make an update to this repository, please update the `CHANGELOG.md` file accordingly. The style of the `CHANGELOG.md` file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+* If you edit the `.xml` file in `src/docs/`, please update the changelog at the bottom of the `.xml` file. The current style is `draft [{DraftNum}] - {Year}-{Month}-{Day} {Initials} {Description}` followed by a new line, where {DraftNum} is an incrementing 2 digit decimal number (can be 00-99), {Year} is the 4 digit year number, {Month} is the 2 digit month number, {Day} is the 2 digit day number, {Initials} are some initials to help differentiate changelog editors (Vi Grey's initials are **VG**, for example), and {Description} is a description of what you changed. (These instructions may change in the future.)
-* If you make an update to this repository, please update the `CHANGELOG.md` file accordingly. The style of the `CHANGELOG.md` file is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), although currently without version numbers added.
-* If you edit the `.xml` file in `src/docs/`, please update the changelog at the bottom of the `.xml` file. The current style is `draft [{DraftNum}] - {Year}-{Month}-{Day} {Initials} {Description}` followed by a new line, where {DraftNum} is an incrementing 2 digit decimal number (can be 00-99), {Year} is the 4 digit year number, {Month} is the 2 digit month number, {Day} is the 2 digit day number, {Initials} are some initials to help differentiate changelog editors (Vi Grey's initials are **VG**, for example), and {Description} is a description of what you changed.
-* If you edit the ``.xml` file in `src/docs/`, use `make clean; make; make contribution` at the root directory of this repository to create the new document files and automatically add them to `docs/latest/` and `docs/tasd-spec-{version}/`.
-* Please (for the moment at least) try to keep individual updates relatively single-subject in nature. For instance, if you're working on fixing a bunch of typos, try to make the update essentially only about fixing typos.
+## Building
+### Dependencies
+- xml2rfc
+- make
+
+`xml2rfc` can be installed from the Python3 PIP package manager (`pip3 install xml2rfc`). Some distributions may prefer you to install programs with pipx instead of pip, like Arch Linux (`pipx install xml2rfc`).
+
+Alternatively, if using linux, xml2rfc may be available in your distribution's repositories via your package manager. For instance, `sudo apt install xml2rfc` on Ubuntu/Debian, or `pacman -S xml2rfc` on Arch Linux (AUR).
+
+### Build (temporary instructions)
+From a terminal, go to the the main directory of this project (the directory this CONTRIBUTING.md file exists in). You can then build the HTML and TXT formatted documents with:
+```sh
+make documents
+```
+After building the documentation, you should find the exported `.html` and `.txt` files in the `build/docs/` directory.
+
+The source code for the documentation can be found in `src/docs/`. The xml2rfc vocabulary of the xml file is explained in [RFC 7991](https://www.rfc-editor.org/rfc/rfc7991).
+
+To copy the generated HTML and TXT files to the final `docs/` directory, run:
+```sh
+make contribution
+```