puma.rc/tuxbot-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

New readme

Browse source
This commit is contained in:
Maël 2018-11-18 03:14:19 +01:00 committed by GitHub
parent a690049e7e
commit 7b26b684f9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
readme.md
View file

@ -1,22 +1,26 @@
# Tuxbot # Tuxbot
TuxBot, un bot discord écrit en Python. TuxBot, un bot discord écrit en Python.
Ici ce trouve le code source du bot provenant du serveur Discord [Aide GNU/Linux-Fr"](https://discord.gg/79943dJ "Rejoindre le serveur"), il à été créé spécialement pour ce discord, si vous souhaitez l'utiliser il vous faudra modifier ``params.json`` et ``cogs/utils/checks.py`` ;) Ici ce trouve le code source du bot provenant du serveur Discord [Aide GNU/Linux-Fr"](https://discord.gg/79943dJ "Rejoindre le serveur"), il à été créé spécialement pour ce discord, si vous souhaitez l'utiliser il vous faudra modifier.
/!\ La partie web est temporairement H-S.
### Pré-requis ### Pré-requis
Il vous faut : Il vous faut :
- Un ordinateur sous **GNU/Linux** avec une connexion à internet; - Un ordinateur sous **GNU/Linux** avec une connexion à internet;
- Python3.5 ou + ; - Python3.7 ou + ;
- Installer ``requirements.txt`` (avec ``pip3 install -r requirements.txt`` par ex) - Installer ``requirements.txt`` (avec ``pip3 install -r requirements.txt`` par ex)
### Installation ### Installation
Une fois les pré-requis installés et ``config.py`` édité, placez vous dans le repertoire de tuxbot et lancez ``bot.py`` avec python3 (ex: ``python3 bot.py``) Une fois les pré-requis installés et ``config.py`` édité avec les ID discord et Mysql, placez vous dans le repertoire de tuxbot et lancez ``bot.py`` avec python3 (ex: ``python3 bot.py``).
Pour utiliser ``launch.py`` les paquets ``python3-dialog`` et ``screen`` sont requis.
## Démarrage ## Démarrage
Placez vous dans le repertoire de tuxbot et exécutez ``bot.py`` avec python3 (ex: ``python3 bot.py``) Placez vous dans le repertoire de tuxbot et exécutez ``bot.py`` avec python3 (ex: ``python3 bot.py``)
Sinon vous pouvez utiliser ``launch.py`` qui lancera un ``screen`` en arrière plan.
## Fabriqué avec ## Fabriqué avec
* [PyCharm](https://www.jetbrains.com/pycharm/) - Editeur de texte payant :3 * [PyCharm](https://www.jetbrains.com/pycharm/) - Editeur de texte payant :3
@ -32,10 +36,3 @@ Liste des versions : [Cliquer pour afficher](https://github.com/outout14/tuxbot-
## License ## License
Ce projet est sous licence ``Creative Commons BY-NC-SA 4.0`` - voir le fichier [LICENSE.md](LICENSE.md) pour plus d'informations Ce projet est sous licence ``Creative Commons BY-NC-SA 4.0`` - voir le fichier [LICENSE.md](LICENSE.md) pour plus d'informations
## Support on Beerpay
Hey dude! Help me out for a couple of :beers:!
[![Beerpay](https://beerpay.io/outout14/tuxbot-bot/badge.svg?style=beer-square)](https://beerpay.io/outout14/tuxbot-bot) [![Beerpay](https://beerpay.io/outout14/tuxbot-bot/make-wish.svg?style=flat-square)](https://beerpay.io/outout14/tuxbot-bot?focus=wish)