diff --git a/stories/README.md b/stories/README.md new file mode 100644 index 0000000..adeef1a --- /dev/null +++ b/stories/README.md @@ -0,0 +1,36 @@ +# Description + +This is a small multiplayer game. + +Each player starts a story by writing a sentence. +Then the story is passed to the next player. +Each player only sees the last sentence and writes a sentence to continue the story. +After a predefined number of rounds the game is finished. +The resulting stories are presented to all players. + +# Installation +pip install -r requrements.txt + +# Usage +python manage.py migrate +python manage.py runserver + +# Technical Overview + +To start a game a StoryRound is started. +Participants are added, and an ordering of Participants is selected and a . + +To start every Participant gets a Story and starts it with a sentence (StoryPart). +Then the story is passed to the next Participant according to the ordering. + +# MVP Plan + +![Mockup](documentation/user_interface_mockup.png) + +- [ ] Create Form to start a StoryRound (with forced alphabetical ordering) +- [ ] Build Sentence writing page +- [ ] Build result view +- [ ] include open and past round links in start page + +# Backlog +- [ ] Create Wizzard for StoryRound including custom Ordering diff --git a/stories/documentation/user_interface_mockup.png b/stories/documentation/user_interface_mockup.png new file mode 100644 index 0000000..301d114 Binary files /dev/null and b/stories/documentation/user_interface_mockup.png differ