diff --git a/.gitignore b/.gitignore index 174f0b8..cc48d81 100644 --- a/.gitignore +++ b/.gitignore @@ -118,4 +118,3 @@ app.*.symbols !/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages !/dev/ci/**/Gemfile.lock -docs/build/ diff --git a/docs/build-pdf/.gitignore b/docs/build-pdf/.gitignore new file mode 100644 index 0000000..a136337 --- /dev/null +++ b/docs/build-pdf/.gitignore @@ -0,0 +1 @@ +*.pdf diff --git a/docs/build.sh b/docs/build.sh new file mode 100755 index 0000000..b0cd9fe --- /dev/null +++ b/docs/build.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +cd -- "$(dirname -- "$(readlink -f -- "$0")")" || exit 1 +files_docs=(*.md) +files_protocols=(protocols/*.md) + +files=("${files_docs[@]}" "${files_protocols[@]}") +[ -e "${files[0]}" ] || { + echo "No files found" + exit 1 +} + +for filename in "${files[@]}"; do + name="${filename%%.*}" + echo "$name" + pandoc --pdf-engine=xelatex -V mainfont="DejaVu Serif" --output="build-pdf/$name.pdf" "$filename" +done diff --git a/docs/concept.md b/docs/concept.md index 9d8d748..15e4897 100644 --- a/docs/concept.md +++ b/docs/concept.md @@ -1,14 +1,39 @@ # Concept -- Homescreen - The homescreen of the App should display a list of upcoming tournaments - and a button to a tournament you are participating in. - If you press on a tournament in the list, the detail view should open -- Tournament Detail View - The tournament detail view displays all the information about a tournament, - like +## Homescreen + +The homescreen of the App should display a list of upcoming tournaments +and a button to a tournament you are participating in. + +## Setting + +Dropdowns for +- Theme (System, Dark, Light) +- Language (English, German) +Textbox for +- Team Name + +## Tournament Detail View + +The tournament detail view displays all the information about a tournament, +like + - The registration period - The maximum amount of teams +- The Tournament Format - Preview pictures - A button for registering your Team if in the registration period - A button to view the stats of the tournament if it has been completed or is currently ongoing + +## Tournament Teams View + +Displays a List of Teams that have entered the Tournament + +## Current Tournament View + +The current tournament view displays the current state of an ongoing tournament which the participant entered in. + + +## Mockups + +![Mockups](images/mockups.png) \ No newline at end of file diff --git a/docs/images/mockups.png b/docs/images/mockups.png new file mode 100644 index 0000000..d1536ec Binary files /dev/null and b/docs/images/mockups.png differ