Merge pull request #221 from AAU-P5-Moodle/Update-Readme

Update readme

README.md

@@ -0,0 +1,28 @@
+[![codesniffer](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/codesniffer.yml/badge.svg)](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/codesniffer.yml?event=push)
+[![Behat](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/behat.yml/badge.svg)](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/behat.yml?event=push)
+[![PHPUnit](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/phpunit.yml/badge.svg)](https://github.com/AAU-P5-Moodle/moodle-1/actions/workflows/phpunit.yml?event=push)
+
+# LiveQuiz
+
+LiveQuiz is a Moodle module that aims to facilitate interactive quizzes for both live classroom use and self-study, while offering a more active practice and learning to students.
+
+This project is developed by students at Aalborg University, as a semester project for the BSc in Software Engineering.
+The project was initiated in 2024, and currently supports creating, editing, and taking quizzes in practice mode. Initial work on the live quiz functionality has been done in the [Websocket branch](https://github.com/AAU-P5-Moodle/moodle-1/tree/websockets-branch).
+
+Development is ongoing and processes on a semester-by-semester basis.
+
+## Development documentation
+
+- [LiveQuiz Wiki](https://github.com/AAU-P5-Moodle/moodle-1/wiki):
+Details about the project, including tech stack, plugin structure, and analysis.
+- [Setup Guide using Nix-shell](https://github.com/AAU-P5-Moodle/moodle-1/wiki/nix-and-nix%E2%80%90shell): Instructions for setting up the development environment using Nix-shell.
+- [Scrum Board](https://github.com/orgs/AAU-P5-Moodle/projects/2):
+Overview of the development process, including tasks and progress tracking.
+- [Moodle Readme](https://github.com/AAU-P5-Moodle/moodle-1/wiki/Moodle-Readme):
+This is the initial readme that is provided with Moodle.
+- [First Good Issues](https://github.com/AAU-P5-Moodle/moodle-1/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22):
+Issues to get you started.
+
+## License
+
+LiveQuiz is a plugin for Moodle and is distributed under the GNU General Public License v3 (GPLv3). For details, see the LICENSE file or visit https://www.gnu.org/licenses/gpl-3.0.html.