summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-04-05 12:23:49 +0300
committerLars Wirzenius <liw@liw.fi>2021-04-05 12:23:49 +0300
commit7cdc71684aefae9162559e12d2b095e209f1b81e (patch)
tree3182ec5f51e1f01935acfa38011724307cec2f9c /README.md
parent1942abc7d08f5f825e24588ca013922dd56b76d0 (diff)
downloadbumper-rs-7cdc71684aefae9162559e12d2b095e209f1b81e.tar.gz
docs: add a README
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5acd0e5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Bumper &ndash; set version number for a software project
+
+Bumper sets the version number in the right places for a software
+project. For more details on goals, requirements, and
+implementation details, see the [bumper.md](bumper.md) subplot file,
+rendered online at <https://bumper.liw.fi/>.
+
+## Legalese
+
+Copyright 2021 Lars Wirzenius
+
+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.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.