From a48be15f916f9d9045f9ad1b9e899b370cb98126 Mon Sep 17 00:00:00 2001 From: Vi Grey Date: Mon, 26 Sep 2022 05:00:02 -0500 Subject: Add TODO.md file Add TODO.md file Add "Licenses" section in `README.md` file Add "Contributing" section in `README.md` file Remove "TODO" section in `README.md` file --- CHANGELOG.md | 10 ++++++++++ README.md | 16 +++++++++------- TODO.md | 7 +++++++ 3 files changed, 26 insertions(+), 7 deletions(-) create mode 100644 TODO.md diff --git a/CHANGELOG.md b/CHANGELOG.md index b349ab4..7d1f30a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), although currently without version numbers added. +## 2022-09-26 +### Added +- TODO.md file +- "Licenses" section in `README.md` file +- "Contributing" section in `README.md` file + +### Removed +- "TODO" section in `README.md` file + + ## 2022-09-26 ### Changed - Rename `docs/draft-tasd-spec-0001/` to `docs/tasd-spec-0001/` diff --git a/README.md b/README.md index b6b1397..8d8a128 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ While files generated by emulator dump scripts should provide as much informatio ## **Reading the Specification Documentation** -The specification documentation can be found at `docs/draft-tasd-0001.html`, `docs/draft-tasd-0001.pdf`, and `docs/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`, `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. ## **Building the Specification Documentation** @@ -49,10 +49,12 @@ A tool to convert a TASD file to an r08 file can be found at `tools/tasd2r08/tas [TASD-Edit](https://github.com/bigbass1997/TASD-Edit) is a cross-platform, CLI-based editor for TASD files. Can create/edit TASD files, and import or export legacy formats: r08, r16m, and GBI. -## TODO -- Add usage explanation for tools -- Add dump script support for more emulators and for more consoles -- Add `CONTRIBUTIONS.md` file with general rules for contributing to this project, especially for updating `CHANGELOG.md` and the end changelog at `src/docs/draft-tasd-0001.xml` -- Develop and add tools that make TASD file editing easier -- Possibly split this TODO into another file \ No newline at end of file +## Contributing + +If you wish to contribute to this project, please take a look at `CONTRIBUTING.md` + + +## Licenses + +To see the licenses of the specification documentation along with any included tools, please look at `LICENSE.txt` \ No newline at end of file diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..f0ed235 --- /dev/null +++ b/TODO.md @@ -0,0 +1,7 @@ +List of things that would probably be good to add in the future + +- Add usage explanation for tools in `README.md` +- Add dump script support for more emulators and for more consoles +- Add more tools that make creating or editing TASD files easier +- Add packet examples to `src/docs/draft-tasd-spec-0001.xml` +- Add example `.tasd` files -- cgit v1.2.3