Author: Adam <git@apiote.xyz>
update README
CODE_OF_CONDUCT | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.asciidoc | 36 +++++++++++++++++++++-------------
diff --git a/CODE_OF_CONDUCT b/CODE_OF_CONDUCT new file mode 100644 index 0000000000000000000000000000000000000000..2cb5c002825de7be54a79e29e80614a44e373c5a --- /dev/null +++ b/CODE_OF_CONDUCT @@ -0,0 +1,53 @@ +Code of Merit + +1. The project creators, lead developers, core team, constitute +the managing members of the project and have final say in every decision +of the project, technical or otherwise, including overruling previous decisions. +There are no limitations to this decisional power. + +2. Contributions are an expected result of your membership on the project. +Don't expect others to do your work or help you with your work forever. + +3. All members have the same opportunities to seek any challenge they want +within the project. + +4. Authority or position in the project will be proportional +to the accrued contribution. Seniority must be earned. + +5. Software is evolutive: the better implementations must supersede lesser +implementations. Technical advantage is the primary evaluation metric. + +6. This is a space for technical prowess; topics outside of the project +will not be tolerated. + +7. Non technical conflicts will be discussed in a separate space. Disruption +of the project will not be allowed. + +8. Individual characteristics, including but not limited to, +body, sex, sexual preference, race, language, religion, nationality, +or political preferences are irrelevant in the scope of the project and +will not be taken into account concerning your value or that of your contribution +to the project. + +9. Discuss or debate the idea, not the person. + +10. There is no room for ambiguity: Ambiguity will be met with questioning; +further ambiguity will be met with silence. It is the responsibility +of the originator to provide requested context. + +11. If something is illegal outside the scope of the project, it is illegal +in the scope of the project. This Code of Merit does not take precedence over +governing law. + +12. This Code of Merit governs the technical procedures of the project not the +activities outside of it. + +13. Participation on the project equates to agreement of this Code of Merit. + +14. No objectives beyond the stated objectives of this project are relevant +to the project. Any intent to deviate the project from its original purpose +of existence will constitute grounds for remedial action which may include +expulsion from the project. + +This document is adapted from the Code of Merit, version 1.0. +See: https://codeofmerit.org/. diff --git a/README.asciidoc b/README.asciidoc index 270f97bda048f533b6e5b9119688f37bd725dd41..b297dbcbfd44c5f1860705d7a8c9e4c8b81e48c6 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -1,10 +1,13 @@ = meowsum +apiote <me@apiote.xyz> +v1.0.0 2022-06-17 +:toc: -== NAME +== Name meowsum — print or verify Meow hash checksums -== DESCRIPTION +== Description The meowsum utility calculates and prints or verifies https://mollyrocket.com/meowhash[Meow hash] checksums. The output format is consistent with POSIX cksum; @@ -12,7 +15,7 @@ meowsum prints the checksum, number of bytes, and file path to standard output. The meowsum is an alternative for such utilities as `cksum`, `md5sum`, `sha512sum`. -== USAGE +== Usage meowsum -h meowsum [-ceq] FILE... @@ -21,12 +24,12 @@ -h show this help and exit -c read sums from the FILEs and check them -s size set hash size; size can be 32, 64, 128 bits; - the default is 128 + the default is 128 The following options are useful only when verifying checksums: -q only return status; do not print OK, ERH, ERS, ERM -e fail for missing files -== BUILDING +== Building meowsum uses mk for building but it can also be built manually. @@ -40,33 +43,38 @@ To compile only meowsum, run `mk meowsum`. To generate only the manpage, run `mk meowsum.1`. To build everything at once, run just `mk`. -== INSTALLATION +== Installation meowsum can be installed using mk, but also manually. To install using mk, run `mk install` as root. This will copy the binary to `$PREFIX/bin/`, which is `/usr/local/bin/` by default, and the manpage to `/usr/share/man/man1/`. -== FUTURE +== Future meowsum might be rewritten to another language, but it will definitely not be Rust. It is, however, feature complete. Feature requests and patches with new features will be dropped. -== CONTRIBUTING +== Contributing -Bug fixes are welcome and can be submitted by email to git+meowsum@apiote.tk. -Mind that all mail sent to that address is or will be public in https://asgard.apiote.tk/mimir[apiote’s mail archive]. +This project is finished; no more functions will be implemented; all feature requests will be ignored. -== AUTHORS +This project uses The Code of Merit, which is available as CODE_OF_CONDUCT file. -Maintained by Adam Pioterek <me@apiote.tk>. +Fixes and patches are welcome; please send them to `meowsum@git.apiote.xyz` using `git send-email`. They must include a sign-off to certify agreement to https://developercertificate.org/[Developer Certificate of Origin]. + +All communication—questions, bugs, etc.—should go through the mailing list available at `meowsum@git.apiote.xyz`. Note that all communication will be made public at https://asgard.apiote.xyz/. + +== Authors + +Maintained by apiote <me@apiote.xyz>. Meowhash created by https://github.com/cmuratori/meow_hash[mollyrocket], Zlib license. -== COPYRIGHT +== Copyright -Copyright (C) 2021 Adam Pioterek +Copyright (C) 2021 apiote This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.