Skip to content
Snippets Groups Projects
Commit 645348b3 authored by Josef Olsson's avatar Josef Olsson
Browse files

Minor changes in introduction files

parent 1907e56a
No related branches found
No related tags found
1 merge request!159Resolve "Documentation"
Introduction
============
Here we give a short intrduction to both the project as a whole and our system.
This is a short introduction to both the project as a whole and our system.
.. toctree::
:maxdepth: 2
......
# Introduction to the project
Here we give short introduction to the project.
We also give links to other relevant things to read before choosing this project.
This is a short introduction to the project.
There are several links to other relevant things to read before choosing this project.
## Before choosing this project
......@@ -9,21 +9,21 @@ There are a lot of things this system needs to do.
To get a complete description, see the [original repository](https://github.com/TechnoX/teknikattan-scoring-system#beskrivning-av-hur-man-anv%C3%A4nder-systemet) from Teknikåttan.
There you will see exactly what is expected of the system (click on each picture to see a video that will give a more in-depth explanation).
You may also what to look at the [description of the project](https://github.com/TechnoX/teknikattan-scoring-system/blob/master/kandidatarbete_teknikattan.md), if you have not already done so.
There is a lot to read (and watch) on these two links, but doing so will give you a complete picture of the requirements.
There is a lot to read (and watch) on these two links, but in doing so you will get a complete picture of the requirements.
Make sure you understand what this project entails before continuing with it, it is not as "simple" as it might first seem.
## Our perspective
This was a fun project.
In contrast to some other project the purpose of this one, what it's requirements are and why it's useful is clear.
It is really fun developing a product you know (if it turns out well) many people will appreciate, use and see.
In contrast to some other previous projects the purpose of this one, what it's requirements are and why it's useful, is clear.
It is really fun developing a product you know (if it turns out well) many people will appreciate, use, and see.
But on the other hand the project is large.
There was a group that worked on this project before us.
We could have continued there project when we began, but we decided not to.
We could have continued their project when we began, but we decided not to.
This was in part due to it not really working and in part due to lack of documentation.
We hope to have learned from that mistake.
That is why we have made a proper documentation (the one you are reading right now!) and decent, working foundation of the system.
That is why we have made proper documentation (the one you are reading right now!) and a decent, working foundation of the system.
We have also made an effort to document the code as much as possible.
We hope you continue on our efforts if you choose this project.
......
# Introduction to our system
This system was allows a user to create, edit and host competitions.
Below we describe in short what our system allows you to do.
This system allows a user to create, edit and host competitions.
Below it is in short described what the system allows you to do.
If you want a more exact description (with pictures!), see the [user manual](../user_manual.rst)
## Login
After logging in you will be able to see all competitions and edit them.
If you're an admin you will also be able to see all users and edit them.
You are also able to connect to an active competition from the same screen you used to login.
You will also be able to connect to an active competition from the same screen you used to login.
## Editor
The editor allows you to edit competitions.
You can add, remove and reorder slides.
You can add, delete and edit teams, text and image components, question type, correcting instructions and background image.
You can add, delete and edit:
- teams
- text and image components
- questions
- question types
- correcting instructions
- background image.
## Active competitions
You can also start a competition.
This will let other people join it with codes that can be seen either before or after starting a presentation.
Then when you switch slides, start the timer or show the current score it will also happen for every other person connected to the same competition.
Then when you switch slides, start the timer or show the current score, it will also happen for every other person connected to the same competition.
Depending on which code someone uses to join an active competition they will see different things, which we call different views.
The team view will allow the user to answer the questions.
The judge view will allow the user to see correct answers and give a score to the questions answered by a team.
The audience view will show the current slide.
Depending on which code someone uses to join an active competition they will see different things, which we call different _views_.
The _team view_ will allow the user to answer the questions.
The _judge view_ will allow the user to see correct answers and give a score to the questions answered by a team.
The _audience view_ will show the current slide.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment