From dcbbdbff6dc2eb2ba915dc25f369daa7db837633 Mon Sep 17 00:00:00 2001 From: angie Date: Thu, 21 Sep 2023 11:17:11 -0300 Subject: [PATCH] Add changelog and markdownlint file --- .gitignore | 2 -- .markdownlint.jsonc | 14 ++++++++++++++ .vscode/extensions.json | 7 +++++++ CHANGELOG.md | 23 +++++++++++++++++++++++ README.md | 21 +++++++++++++-------- 5 files changed, 57 insertions(+), 10 deletions(-) create mode 100644 .markdownlint.jsonc create mode 100644 .vscode/extensions.json create mode 100644 CHANGELOG.md diff --git a/.gitignore b/.gitignore index da00728..631da74 100644 --- a/.gitignore +++ b/.gitignore @@ -162,8 +162,6 @@ cython_debug/ #.idea/ -# -.vscode/ asm/ *.z64 diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..ef8db42 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,14 @@ +{ + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md + // MD024 - Multiple headings with the same content + "MD024": { + "siblings_only": true + }, + + // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md + // MD013 - Line length + "MD013": { + "code_block_line_length": 120, + "headings": false + } +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..a20a77e --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,7 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "davidanson.vscode-markdownlint" + ] +} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f82637c --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,23 @@ +# Changelog + +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.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Allow invoking `ipl3checksum` as a CLI program + - Currently it only allows the `-V`/`--version` to print the version of the library +- A `CHANGELOG.md` + +## [1.0.0] - 2023-09-21 + +### Added + +- Initial relase + +[unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/1.0.0...HEAD +[1.0.0]: https://github.com/Decompollaborate/ipl3checksum/releases/tag/1.0.0 diff --git a/README.md b/README.md index 5a3b97e..602d5e0 100644 --- a/README.md +++ b/README.md @@ -38,21 +38,26 @@ print(cickind) # Either a `ipl3checksum.CICKind` or None if was not able to dete ## Where does this come from? -This algorithm comes directly from the IPL3, which each variant is part of the first 0x1000 bytes of the rom of every retail N64 ROM. +This algorithm comes directly from the IPL3, which each variant is part of the +first 0x1000 bytes of the rom of every retail N64 ROM. -There are various implementations floating around on the internet, but for this specific one was reverse-engineered by myself. -I made this because I couldn't find a library to calculate this checksum, so I decided to reverse-engineer it myself instead of -taking somebody else's work. It also was an interesting learning experience. +There are various implementations floating around on the internet, but for this +specific one was reverse-engineered by myself. I made this because I couldn't +find a library to calculate this checksum, so I decided to reverse-engineer it +myself instead of taking somebody else's work. It also was an interesting +learning experience. ## Note about licensing -Most of the repository is licensed under the [MIT license](LICENSE), but I also made a -[reference implementation](docs/reference_implementation.md) that is part of the public domain (licensed under CC0-1.0), feel free to -use it however you prefer (acknowledgment is always appreciated, but not required). +Most of the repository is licensed under the [MIT license](LICENSE), but I also +made a [reference implementation](docs/reference_implementation.md) that is part +of the public domain (licensed under CC0-1.0), feel free to use it however you +prefer (acknowledgment is always appreciated, but not required). ## I want to learn more! What is an IPL3? What is CIC? -I'm not really the guy that can answer all your hunger for knowledge, but here are a few links that may be helpful: +I'm not really the guy that can answer all your hunger for knowledge, but here +are a few links that may be helpful: * CIC-NUS: * Initial Program Load 3 (IPL3)