From 7c0607d4a96b3d7188b42f7789297a6e97f1136f Mon Sep 17 00:00:00 2001 From: Tom Teichler <tom.teichler@teckids.org> Date: Tue, 26 Nov 2019 22:17:30 +0100 Subject: [PATCH] Rewrite README. --- README.md | 40 ---------------------------------------- README.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 40 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 52cc13eeb..000000000 --- a/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# BiscuIT - The Free School Information System (SIS) - Next Generation Platform - -## Warning - -**This is a preview version of BiscuIT. Do not use with sensitive data. Especially, do not grant access to students yet.** - -## What BiscuIT is - -BiscuIT is a web-based school information system (SIS) which can be used to -manage and/or publish organisational subjects of educational institutions. - -It was originally developed together with Städt. Leibniz-Gymnasium Remscheid -as a proprietary product. Five years after the school stole the original -code base, BiscuIT-ng started as a complete re-implementation as -well-designed, free and open source software. - -BiscuIT-ng is a platform based on Django, that provides central funstions -and data structures that can be used by apps that are developed and provided -seperately. The core can interact closely with the Debian Edu / Skolelinux -system. - -## Core features - -TBA. - -## Official add-on apps - -| App name | Purpose | -| ------------------------------------ | --------------------------------------------------- | -| [Alsijil][BiscuIT-App-Alsijil] | Class register and school records | -| [Chronos][BiscuIT-App-Chronos] | Manage time tables | -| [Exlibris][BiscuIT-App-Exlibris] | School book management | -| [SchILD-NRW][BiscuIT-App-SchILD-NRW] | SchILD-NRW interface | -| [Untis][BiscuIT-App-Untis] | Untis interface | - -[BiscuIT-App-Alsijil]: https://edugit.org/Teckids/BiscuIT/BiscuIT-App-Alsijil -[BiscuIT-App-Chronos]: https://edugit.org/Teckids/BiscuIT/BiscuIT-App-Chronos -[BiscuIT-App-Exlibris]: https://edugit.org/Teckids/BiscuIT/BiscuIT-App-Exlibris -[BiscuIT-App-SchILD-NRW]: https://edugit.org/Teckids/BiscuIT/BiscuIT-App-SchILD-NRW -[BiscuIT-App-Untis]: https://edugit.org/Teckids/BiscuIT/BiscuIT-App-Untis diff --git a/README.rst b/README.rst new file mode 100644 index 000000000..f6ef25051 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +BiscuIT - The Free School Information System (SIS) - Next Generation Platform +============================================================================== + +Warning +------- + +**This is a preview version of BiscuIT. Do not use with sensitive data. Especially, do not grant access to students yet.** + + +What BiscuIT is +---------------- + +BiscuIT is a web-based school information system (SIS) which can be used to +manage and/or publish organisational subjects of educational institutions. + +It was originally developed together with Städt. Leibniz-Gymnasium Remscheid +as a proprietary product. Five years after the school stole the original +code base, BiscuIT-ng started as a complete re-implementation as +well-designed, free and open source software. + +BiscuIT-ng is a platform based on Django, that provides central funstions +and data structures that can be used by apps that are developed and provided +seperately. The core can interact closely with the Debian Edu / Skolelinux +system. + +Core features +-------------- + +TBA. + +Licence +------- + +:: + + Copyright © 2019 Dominik George <dominik.george@teckids.org> + Copyright © 2019 mirabilos <thorsten.glaser@teckids.org> + Copyright © 2019 Tom Teichler <tom.teichler@teckids.org> + + Licenced under the EUPL + +Please see the LICENCE file accompanying this distribution for the +full licence text or on the `Europen Union Public Licence`_ website +(including all other official language versions). + +.. _BiscuIT-ng: https://edugit.org/BiscuIT/BiscuIT-ng -- GitLab