Skip to content

Commit 0fe7c33

Browse files
Update README.md
1 parent ee1587c commit 0fe7c33

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
1-
# task-assigner
2-
The Task Assigner tool is used to assign a list of tasks _(input by the user)_ to a list of people _(also input by the user)_.
1+
# Task Assigner
2+
3+
## Description
4+
This tool implements a task assignment system that randomly assigns tasks to individuals based on predefined rules. So far, the rules are:
5+
1. Everyone will be assigned only with their eligible tasks.
6+
2. _TBC_
7+
8+
## Installation
9+
1. Download `main.py` in `src` folder.
10+
2. Modify the list of people and their eligible tasks based on your own case.
11+
3. Modify the number of weeks you want to generate.
12+
13+
### Python Version
14+
This project was written using `Python 3.9`. Make sure you have Python 3.9 or a compatible version installed before running the tool.
15+
16+
## License
17+
This project is licensed under the [GPL-3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html).

0 commit comments

Comments
 (0)