feat: add support for placeholder escaping, prep for release, misc

kbdharun commented 1 month ago

Changes

Add support for placeholder escaping to comply with the latest specification.
Add "tldr-pages contributors" to the copyright name beside the original client author.
Remove the contact email of the original author since they aren't involved anymore.
Update PyPi categories in setup.py adding Python 3.12 and BSD platforms as supported.
Update the docs directory in the .gitignore file and add a man page for local builds (#233).
Update Snapcraft (snap) config to core24 (Ubuntu LTS 24.04) and Python 3.12 (also removed some unnecessary comments).
Minor fixes to README and add Snap release badge.
Add CHANGELOG, bump, and client spec versions to 3.3.0 and v2.2, respectively.

I have been working on this since yesterday, and the changes are finally done. After this PR's merge, I will create a new release and once it is done will bump the Snapcraft files version.

This time the changelog is really big xD.

Related issues

Closes #233
Closes #237

Sample Screenshots

Placeholder escaping

For more details check out https://github.com/search?q=repo%3Atldr-pages%2Ftldr+%5C%7B%5C&type=code

New badge in README

patricedenis commented 1 month ago

It looks good ! All of those improvements, congrats @kbdharun and thanks ! I found a few minor addition that I could suggest, I will add them shortly.

kbdharun commented 1 month ago

I found a few minor addition that I could suggest, I will add them shortly.

If it's related to the PR feel free to suggest it here, if it's a new feature/minor update sure we can add it later.

patricedenis commented 1 month ago

Yeah thanks, I've just made a PR to this branch because I was not able to add it directly from the review process.

patricedenis commented 1 month ago

Ok @kbdharun : my PR on the brand does not seem to wook properly. The suggestion was to replace the line 60 on README.md from : [linux, osx, sunos, windows, common] to [android, linux, osx, sunos, windows, freebsd, netbsd, openbsd, common]

or better : android, freebsd, linux, netbsd, openbsd, osx, sunos, windows, common as you had written in the man doc.

tldr-pages / tldr-python-client