aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef40c7c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+<p align="center">
+ <a href="https://github.com/mssola/operum/actions?query=workflow%3ACI" title="CI status for the main branch"><img src="https://github.com/mssola/operum/workflows/CI/badge.svg" alt="Build Status for main branch" /></a>
+</p>
+
+---
+
+> mille dea est operum: certe dea carminis illa est; <br />
+> &emsp; si mereor, studiis adsit amica meis.
+>
+> &mdash; P. Ovidi Nasonis - Fasti 3.833-834
+
+This is a small application in order to keep track of books, articles, papers,
+etc.; that you might have and need to know where they are, reference it on a
+paper, etc. To sum things up, it's a way to keep your bibliography under
+control.
+
+## Basic usage
+
+To do.
+
+## Deployment
+
+To do.
+
+OPERUM_BASE_TITLE
+OPERUM_DEFAULT_LOCALE
+
+## Contributing
+
+Do you want to contribute with code, or to report an issue you are facing? Read
+the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+
+## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small)
+
+Read the [CHANGELOG.md](./CHANGELOG.md) file.
+
+## License
+
+```txt
+Copyright (C) 2023-Ω Miquel Sabaté Solà <mikisabate@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+```