From 57bb2459b775cce05b6297ac1c78ca2f99954c91 Mon Sep 17 00:00:00 2001 From: Mo8it Date: Sat, 19 Nov 2022 19:51:00 +0100 Subject: [PATCH] Replace README --- README.adoc | 22 ---------------------- README.md | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 22 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index acb65f3..0000000 --- a/README.adoc +++ /dev/null @@ -1,22 +0,0 @@ -= AdvLabDB - -image:https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white[pre-commit, link=https://github.com/pre-commit/pre-commit] image:https://img.shields.io/badge/code%20style-black-000000.svg[Code style: black, link=https://github.com/psf/black] image:https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336[Imports: isort, link=https://pycqa.github.io/isort/] image:https://img.shields.io/badge/security-bandit-yellow.svg[Security: bandit, link=https://github.com/PyCQA/bandit] - -== About -AdvLabDB is a database with a web interface for labs. - -// TODO: Screenshots - -// TODO: Features - -Admins have an interface to manage students, groups, experiments, appointments, marks and analyse data. - -Assistants have a separate interface to set marks and schedule appointments with students. - -== Status -The software is still in beta and under active development. Do not hesitate to open issues! - -// TODO: New setup with containers - -== What does the name mean? -**Adv**anced **Lab** **D**ata**B**ase diff --git a/README.md b/README.md new file mode 100644 index 0000000..a9a9a39 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# AdvLabDB + +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) +[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) +[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) + +## About + +AdvLabDB is a database with a web interface for labs. + +// TODO: Screenshots + +// TODO: Features + +Admins have an interface to manage students, groups, experiments, appointments, marks and analyse data. + +Assistants have a separate interface to set marks and schedule appointments with students. + +## Status + +Advlabdb is near the end of the beta stage and under active development. Do not hesitate to open issues! + +// TODO: Setup with containers + +## What does the name mean? + +**Adv**anced **Lab** **D**ata**B**ase