From 0872b378d47851ad27032aa1b06e61a1babf4960 Mon Sep 17 00:00:00 2001 From: Jeffrey Paul Date: Mon, 9 Dec 2024 02:20:24 +0000 Subject: [PATCH] update readme to conform with my new readme howto standards --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 50 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a0df0a..062276a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,48 @@ # mfer -Manifest file generator and checker. +[mfer](https://git.eeqj.de/sneak/mfer) is a reference implementation library +and thin wrapper command-line utility written in [Go](https://golang.org) +and first published in 2022 under the [WTFPL](https://wtfpl.net) (public +domain) license. It specifies and generates `.mf` manifest files over a +directory tree of files to encapsulate metadata about them (such as +cryptographic checksums or signatures over same) to aid in archiving, +downloading, and streaming, or mirroring. The manifest files' data is +serialized with Google's [protobuf serialization +format](https://developers.google.com/protocol-buffers). The structure of +these files can be found [in the format +specification](https://git.eeqj.de/sneak/mfer/src/branch/main/mfer/mf.proto) +which is included in the [project +repository](https://git.eeqj.de/sneak/mfer). + +The current version is pre-1.0 and while the repo was published in 2022, +there has not yet been any versioned release. [SemVer](https://semver.org) +will be used for releases. + +This project was started by [@sneak](https://sneak.berlin) to scratch an +itch in 2022 and is currently a one-person effort, though the goal is for +this to emerge as a de-facto standard and be incorporated into other +software. A compatible javascript library is planned. # Build Status [![Build Status](https://drone.datavi.be/api/badges/sneak/mfer/status.svg)](https://drone.datavi.be/sneak/mfer) +# Participation + +The community is as yet nonexistent so there are no defined policies or +norms yet. Primary development happens on a privately-run Gitea instance at +[https://git.eeqj.de/sneak/mfer](https://git.eeqj.de/sneak/mfer) and issues +are [tracked there](https://git.eeqj.de/sneak/mfer/issues). + +Changes must always be formatted with a standard `go fmt`, syntactically +valid, and must pass the linting defined in the repository (presently only +the `golangci-lint` defaults), which can be run with a `make lint`. The +`main` branch is protected and all changes must be made via [pull +requests](https://git.eeqj.de/sneak/mfer/pulls) and pass CI to be merged. +Any changes submitted to this project must also be +[WTFPL-licensed](https://wtfpl.net) to be considered. + + # Problem Statement Given a plain URL, there is no standard way to safely and programmatically @@ -170,6 +207,15 @@ regardless of filesystem format. Please email [`sneak@sneak.berlin`](mailto:sneak@sneak.berlin) with your desired username for an account on this Gitea instance. -I am currently interested in hiring a contractor skilled with the Go -standard library interfaces to specify this tool in full and develop a -prototype implementation. +## Links + +* Repo: [https://git.eeqj.de/sneak/mfer](https://git.eeqj.de/sneak/mfer) +* Issues: [https://git.eeqj.de/sneak/mfer/issues](https://git.eeqj.de/sneak/mfer/issues) + +# Authors + +* [@sneak <sneak@sneak.berlin>](mailto:sneak@sneak.berlin) + +# License + +* [WTFPL](https://wtfpl.net) \ No newline at end of file