From bd484c470a71fb63c7aa3a65a427226aff02adaf Mon Sep 17 00:00:00 2001
From: Matthias Baumgartner <dev@igsor.net>
Date: Sat, 4 Mar 2023 16:37:15 +0100
Subject: README and CHANGELOG

---
 CHANGELOG.md | 20 ++++++++++++++++++++
 README       | 57 ---------------------------------------------------------
 README.md    | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 70 insertions(+), 57 deletions(-)
 create mode 100644 CHANGELOG.md
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..4508589
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,20 @@
+
+# Changelog
+
+## 0.23.03 (Initial release)
+
+### Added
+
+- Desktop application
+- Desktop window
+- Widgets
+  - Browser
+  - Filter
+  - Status
+- Actions and Tiles
+- Assets (buttons, placeholder)
+- Query parsing
+- Config system
+- Logging system
+
+
diff --git a/README b/README
deleted file mode 100644
index 79f4b56..0000000
--- a/README
+++ /dev/null
@@ -1,57 +0,0 @@
-
-tagit - the BSFS frontend
-=========================
-
-
-### Developer tools setup
-
-#### Test coverage (coverage)
-
-Resources:
-* https://coverage.readthedocs.io/en/6.5.0/index.html
-* https://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html
-
-Commands:
-$ pip install coverage
-$ coverage run ; coverage html ; xdg-open .htmlcov/index.html
-
-
-
-#### Static code analysis (pylint)
-
-Resources:
-* https://github.com/PyCQA/pylint
-* https://pylint.org/
-* https://pylint.pycqa.org/en/latest/user_guide/messages/messages_overview.html#messages-overview
-
-Commands:
-$ pip install pylint
-$ pylint tagit
-
-
-
-#### Type analysis (mypy)
-
-Resources:
-* https://github.com/python/mypy
-* https://mypy.readthedocs.io/en/stable/
-
-Commands:
-$ pip install mypy
-$ mypy
-
-
-
-#### Documentation (sphinx)
-
-Resources:
-* 
-* 
-
-Commands:
-$ pip install ...
-$ 
-
-
-
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08707d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+
+tagit - the BSFS browser
+========================
+
+## Installation
+
+You can install tagit via pip:
+
+    $ pip install --extra-index-url https://pip.bsfs.io tagit
+
+
+## Development
+
+Set up a virtual environment:
+
+    $ virtualenv env
+    $ source env/bin/activate
+
+Install tagit as editable from the git repository:
+
+    $ git clone https://git.bsfs.io/tagit.git
+    $ cd tagit
+    $ pip install -e .
+
+Install the following additional packages besides tagit:
+
+    $ pip install coverage mypy pylint
+    $ pip install sphinx sphinx-copybutton sphinxcontrib-video furo
+    $ pip install build
+
+To ensure code style discipline, run the following commands:
+
+    $ coverage run ; coverage html ; xdg-open .htmlcov/index.html
+    $ pylint tagit
+    $ mypy
+
+To build the package, do:
+
+    $ python -m build
+
+To run only the tests (without coverage), run the following command from the **test folder**:
+
+    $ python -m unittest
+
+To build the documentation, run the following commands from the **doc folder**:
+
+    $ make html
+    $ xdg-open build/html/index.html
+
+
-- 
cgit v1.2.3