From 018d4442dae30bd0689385a6c6d2b11b5bbdab73 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:27:09 +0100 Subject: [PATCH 1/9] Add usage to readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cb15f0813..0c8495bc9 100644 --- a/README.md +++ b/README.md @@ -92,10 +92,8 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). -# Development setup -Read the [development docs](https://docs.bracketapp.nl/docs/community/development) for how to run Bracket for development. - -Prerequisites are `yarn`, `postgresql` and `pipenv` to run the frontend, database and backend. +# Usage +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to use Bracket as a user. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. @@ -110,6 +108,11 @@ Read the [deployment docs](https://docs.bracketapp.nl/docs/deployment) for how t Bracket can be run in Docker or by itself (using `pipenv` and `yarn`). +# Development setup +Read the [development docs](https://docs.bracketapp.nl/docs/community/development) for how to run Bracket for development. + +Prerequisites are `yarn`, `postgresql` and `pipenv` to run the frontend, database and backend. + # Translations Based on your browser settings, your language should be automatically detected and loaded. For now, there's no manual way of choosing a different language. From 0832aa27ade1395c158ca3d6ea30e1e7489a6a71 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:27:49 +0100 Subject: [PATCH 2/9] fixup! Add usage to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0c8495bc9..1cc318502 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to use Bracket as a user. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to interact with Bracket as a user. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. From 89270d9f0b22a8eb797789d9db78ab07240b1894 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:28:05 +0100 Subject: [PATCH 3/9] fixup! fixup! Add usage to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cc318502..81993550a 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to interact with Bracket as a user. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to set up a tournament from start to finish with Bracket. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. From 680b7efc60c787b16118b8558506439ccb06bd19 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:28:31 +0100 Subject: [PATCH 4/9] fixup! fixup! fixup! Add usage to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 81993550a..a94584024 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to set up a tournament from start to finish with Bracket. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to set up a tournament in Bracket from start to finish. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. From 3108485512de569f00a4679e5d2ad006c288b53b Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:28:52 +0100 Subject: [PATCH 5/9] fixup! fixup! fixup! fixup! Add usage to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a94584024..89f28fb6f 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to set up a tournament in Bracket from start to finish. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to organise a tournament in Bracket from start to finish. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. From 225d514e0ada416b656db2bb480145321974ef67 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:30:45 +0100 Subject: [PATCH 6/9] fixup! fixup! fixup! fixup! fixup! Add usage to readme --- README.md | 2 +- docs/docs/intro.md | 4 +++- docs/docs/usage/{introduction.md => guide.md} | 0 3 files changed, 4 insertions(+), 2 deletions(-) rename docs/docs/usage/{introduction.md => guide.md} (100%) diff --git a/README.md b/README.md index 89f28fb6f..fe029ea05 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/introduction) for how to organise a tournament in Bracket from start to finish. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/guide) for how to organise a tournament in Bracket from start to finish. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 4e62c2a1f..4b01d7228 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -42,4 +42,6 @@ experience to a project with a real purpose. ## Quickstart -To get started, follow the steps described in [quickstart](running-bracket/quickstart.md) +To get started in selfhosting Bracket, follow the steps described in [quickstart](running-bracket/quickstart.md) + +To learn how to organize a tournament in Bracket, read the [usage guide](usage/guide.md). diff --git a/docs/docs/usage/introduction.md b/docs/docs/usage/guide.md similarity index 100% rename from docs/docs/usage/introduction.md rename to docs/docs/usage/guide.md From a395fbc7f47475d08fe6a8c3d74bbad5fdd38eb5 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:30:57 +0100 Subject: [PATCH 7/9] fixup! fixup! fixup! fixup! fixup! fixup! Add usage to readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe029ea05..9d312143c 100644 --- a/README.md +++ b/README.md @@ -93,7 +93,7 @@ sudo docker exec bracket-backend pipenv run ./cli.py create-dev-db See also the [quickstart docs](https://docs.bracketapp.nl/docs/running-bracket/quickstart). # Usage -Read the [usage guide](https://docs.bracketapp.nl/docs/usage/guide) for how to organise a tournament in Bracket from start to finish. +Read the [usage guide](https://docs.bracketapp.nl/docs/usage/guide) for how to organize a tournament in Bracket from start to finish. # Configuration Read the [configuration docs](https://docs.bracketapp.nl/docs/running-bracket/configuration) for how to configure Bracket. From c394bcd259445a06f8d49d3e302f8b0d2cc130a7 Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:33:35 +0100 Subject: [PATCH 8/9] fixup! fixup! fixup! fixup! fixup! fixup! fixup! Add usage to readme --- docs/docs/intro.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 4b01d7228..12da46e40 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -42,6 +42,7 @@ experience to a project with a real purpose. ## Quickstart -To get started in selfhosting Bracket, follow the steps described in [quickstart](running-bracket/quickstart.md) +To get started in selfhosting Bracket, follow the steps described +in [quickstart](running-bracket/quickstart.md) To learn how to organize a tournament in Bracket, read the [usage guide](usage/guide.md). From 76b1d7672e66eeb54ea969f3d76324da2bf0e6ea Mon Sep 17 00:00:00 2001 From: Erik Vroon Date: Sat, 8 Feb 2025 12:33:48 +0100 Subject: [PATCH 9/9] fixup! fixup! fixup! fixup! fixup! fixup! fixup! fixup! Add usage to readme --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 12da46e40..f67cd4e2d 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -43,6 +43,6 @@ experience to a project with a real purpose. ## Quickstart To get started in selfhosting Bracket, follow the steps described -in [quickstart](running-bracket/quickstart.md) +in [quickstart](running-bracket/quickstart.md). To learn how to organize a tournament in Bracket, read the [usage guide](usage/guide.md).