Add changelog and markdownlint file

.gitignore

@@ -162,8 +162,6 @@ cython_debug/
 #.idea/
 
 
-# 
-.vscode/
 
 asm/
 *.z64

.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
+    }
+}

.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"
+    ]
+}

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

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: <https://n64brew.dev/wiki/CIC-NUS>
 * Initial Program Load 3 (IPL3) <https://n64brew.dev/wiki/Initial_Program_Load#IPL3>