From a15523cfd774175066722dca445a002e6caf81c4 Mon Sep 17 00:00:00 2001 From: Banana Date: Mon, 15 Jan 2024 15:07:48 +0100 Subject: [PATCH] better readme --- README => README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) rename README => README.md (54%) diff --git a/README b/README.md similarity index 54% rename from README rename to README.md index eef9eda..99e4308 100644 --- a/README +++ b/README.md @@ -2,20 +2,33 @@ More information and official release visit: https://www.bananas-playground.net/projekt/bibliotheca -## Usage +# Usage + Self hosted collection management for movies, music or games. Install it on your own webserver (see requirements) and store the information about your collected stuff. -Accessible and usable with a browser. Runs also off a Rapsberry Pi. +Accessible and usable with a browser. Runs also off a Raspberry Pi. Tag and category support. Fulltext search and individual fields per collection. See first-steps.txt for first usage steps. -## Technical information +# Requirements + +See documentation/requirements.txt + +# Technical information + This is build and tested on a linux based OS. Windows support not yet, but it could work. -## third party -https://github.com/FabianBeiner/PHP-IMDB-Grabber with some modifications -https://getuikit.com/ -https://jdan.github.io/98.css/ -https://sortablejs.github.io/Sortable/ +# Contribute + +Want to contribute or found a problem? + +See Contributing document: CONTRIBUTING.md + +# Uses + ++ https://github.com/FabianBeiner/PHP-IMDB-Grabber with some modifications ++ https://getuikit.com/ ++ https://jdan.github.io/98.css/ ++ https://sortablejs.github.io/Sortable/ -- 2.39.5