diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index dd59feb..b1e9be8 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -13,6 +13,11 @@ jobs: steps: - uses: actions/checkout@v7 + - name: Lint Markdown + uses: DavidAnson/markdownlint-cli2-action@v23 + with: + globs: "**/*.md" + - uses: actions/setup-python@v7 with: python-version: "3.11" diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..2bf8ad4 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,8 @@ +{ + "MD013": { + "line_length": 100 + }, + "MD024": { + "siblings_only": true + } +} diff --git a/README.md b/README.md index 1c91858..44b7363 100644 --- a/README.md +++ b/README.md @@ -37,10 +37,11 @@ trivial): The value should be converted to the appropriate number of bytes for its assigned type. The complete internal 9-byte buffer comprises three parts: -* _prefix byte_: a byte indicating the number of the payload bytes in the + +- _prefix byte_: a byte indicating the number of the payload bytes in the buffer; -* _payload bytes_: the bytes holding the integer; -* _trailing bytes_: the zero-fill bytes to complete the buffer. +- _payload bytes_: the bytes holding the integer; +- _trailing bytes_: the zero-fill bytes to complete the buffer. To distinguish between signed and unsigned types, the protocol introduces a little trick: for signed types, their _prefix byte_ value is `256` minus the @@ -182,4 +183,4 @@ Make is optional. Run `make` or `make help` to list these commands in the termin ## Credits and references -* +-