Initial commit. Provide a project title page

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..1f34732
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+<!-- Copyright (C) 2023 Gustav Eek <gustav.eek@fripost.org>
+SPDX-License-Identifier: GPL-3.0-or-later -->
+
+*ranknauto* -- Rank N' Auto, automatic normalized ranking
+
+Quantify a ranked ordered from statistical distributions.
+
+Decide an available distribution, e.g. the log normal, and apply the
+quantiles from that on a ranked priority list. The output will be the
+priority in percentages per item in the list.
+
+Read more:
+
+ * Wikipedia, [Ranking](https://en.wikipedia.org/wiki/Ranking)
+ * Wikipedia, [Quantile](https://en.wikipedia.org/wiki/Quantile)
+
+
+Installation
+============
+
+The implementation language is Rust. Configuration made with
+Cargo. For default compilation, installation and removal run GNU Make:
+
+```
+make
+make install
+make uninstall
+```
+
+Write to the author in order to request binaries for your platform. No
+warranties of a response.
+
+
+Copying
+=======
+
+Rank N' Auto, automatic normalized ranking.
+
+Copyright (C) 2023 Gustav Eek
+
+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/>.
+
+Unless explicitly stated otherwise, any contribution intentionally
+submitted for inclusion is released under the GNU GPL v3 or later,
+without any additional terms or conditions.
+