From 604047f8eb73de91554bcd7f1ebd934ba5470397 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laure=CE=B7t?= Date: Tue, 8 Feb 2022 17:36:20 +0100 Subject: [PATCH] chore(readme): reorganized "Built with" --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b22a40d..58f696e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,41 @@ # B00 plays GBA +B00 plays GBA is an interactive emulator made to entertain people during waiting phases, such as during TVn7 pre-shows. + + + ## Built with +### Technologies + - [Python](https://www.python.org/) - [mGBA](https://mgba.io/) -- [VS Code](https://code.visualstudio.com/) -- [Websockets](https://websockets.readthedocs.io/) - [Redis](https://redis.io/) +- [Websockets](https://websockets.readthedocs.io/) - [Nginx-RTMP](https://hub.docker.com/r/tiangolo/nginx-rtmp/) +- [FFmpeg](https://www.ffmpeg.org) + +### Tools + +- [Poetry](https://python-poetry.org/) +- [Docker](https://www.docker.com/) +- [Kubernetes](https://kubernetes.io/) +- [Docker-slim](https://dockersl.im/) - [AGB-buttontest](https://github.com/heroldev/AGB-buttontest) -## Getting started - -### Prerequisites - -[Poetry](https://python-poetry.org/) should manage every dependencies for you. \ -It is recommended to use [VS Code](https://code.visualstudio.com/) with these extensions : +### [VSCode](https://code.visualstudio.com/) - [ms-python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) -- [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - [Python Docstring Generator](https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring) +- [Conventional Commits](https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits) +- [Remote container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) +- [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) +- [Kubernetes](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.vscode-kubernetes-tools) +- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) +- [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) + + +## Getting started ### Installation @@ -63,8 +79,8 @@ python3 src/emulator.py ## Contributing -This repository is under the [Contributing Covenant](https://www.contributor-covenant.org/) code of conduct. -See [`CONTRIBUTING.md`](https://git.inpt.fr/fainsil/booplaysgba/-/blob/master/CONTRIBUTING.md) for more information.\ +This repository is under the [Contributing Covenant](https://www.contributor-covenant.org/) code of conduct. \ +See [`CONTRIBUTING.md`](https://git.inpt.fr/fainsil/booplaysgba/-/blob/master/CONTRIBUTING.md) for more information. \ Please use [conventional commits](https://www.conventionalcommits.org/). ## License