From ebf1f1119f786bfc1b9344e81ba8e1ff0f369106 Mon Sep 17 00:00:00 2001 From: Tobias Date: Sat, 29 Jul 2023 16:00:01 +0200 Subject: [PATCH] created description --- TODO.md | 9 +++++++-- doc/DESCRIPTION.md | 12 ++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 doc/DESCRIPTION.md diff --git a/TODO.md b/TODO.md index 57286c7..b3be5f4 100644 --- a/TODO.md +++ b/TODO.md @@ -1,5 +1,10 @@ # TODOs -- add upgrade and change_url scripts -- find better way to acquire source files - add documentation +- test app: https://yunohost.org/en/packaging_testing +- add scripts: + - upgrade + - change_url +- find better way to acquire source files +- integration with Jenkins? (gibt ein gitea-Plugin dafür) +- wie mache ich das mit dem Usernamen für meine gitea repositories? da hätte ich gern eclipse statt tobias stehen diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..740d9c3 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,12 @@ +# sr2ini for YunoHost + +## Overview + +sr2ini is a lightweight, single-page initiative tracker for the TTRPG Shadowrun in its 2nd edition. The app helps DMs and players to manage fights by tracking each combatant's initiative, order of action, damage (stun and physical), and wound modifiers. It was written specifically for mobile use and can be installed as a web app. + +This package allows you to install sr2ini quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it. + +## YunoHost specific features + + * supports multi-install + * defaut visibility is public