git » summer » commit f0185c2

Add README, LICENSE, and support for `go install`

author Alberto Bertogli
2023-08-23 17:24:51 UTC
committer Alberto Bertogli
2023-08-23 20:11:24 UTC
parent 2dbb2cb5cbeee33074e1588a08136a33bd984acd

Add README, LICENSE, and support for `go install`

This patch adds a README, a LICENSE, and support for `go install` to make
it easier to install summer.

LICENSE +25 -0
README.md +40 -0
ui.go +1 -1

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..0e1edab
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,25 @@
+summer is under the MIT licence, which is reproduced below (taken from
+http://opensource.org/licenses/MIT).
+
+-----
+
+Copyright (c)  Alberto Bertogli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8469fe8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+
+# summer 🌞 🏖
+
+Utility to detect accidental data corruption (e.g. bitrot, storage media
+problems).  Not intended to detect malicious modification.
+
+Checksums are written to/read from each file's extended attributes.
+
+
+## Status
+
+summer is still under active development. The user interface and on-disk
+format may change in backwards-incompatible ways.
+
+
+## Install
+
+```
+go install blitiri.com.ar/go/summer@latest
+```
+
+
+## Example
+
+The most common use case is to run `summer update`, which writes checksums for
+new or modified files, and verifies the checksums of the files which have not
+been modified.
+
+The `-x` flag stops summer from crossing filesystem boundaries (for each of
+the given paths).
+
+```
+sudo summer -x update /home /etc /usr
+```
+
+## Contact
+
+If you have any bug reports, questions, comments or patches please send them
+to summer@alb.ar.
+
diff --git a/ui.go b/ui.go
index bc8b3a6..d7f0958 100644
--- a/ui.go
+++ b/ui.go
@@ -33,7 +33,7 @@ func Fatalf(format string, args ...interface{}) {
 
 func PrintVersion() {
 	info, _ := debug.ReadBuildInfo()
-	rev := ""
+	rev := info.Main.Version
 	ts := time.Time{}
 	for _, s := range info.Settings {
 		switch s.Key {