mirror of
https://github.com/allthingslinux/tux.git
synced 2024-10-02 16:43:12 +00:00
[Docs] Update README.md
This commit is contained in:
parent
81ee2a245e
commit
65fea2f8d2
2 changed files with 40 additions and 1 deletions
37
README.md
37
README.md
|
@ -19,5 +19,42 @@
|
|||
</p>
|
||||
</div>
|
||||
|
||||
## About
|
||||
|
||||
Tux is a Discord bot for the All Things Linux Discord server. It is designed to provide a variety of features to the server, including moderation, support, utility, and various fun commands. The bot is written in Python using the discord.py library.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
- Python 3.11
|
||||
- [Poetry](https://python-poetry.org/docs/)
|
||||
|
||||
### Steps
|
||||
1. Clone the repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/allthingslinux/tux && cd tux
|
||||
```
|
||||
|
||||
2. Install the dependencies
|
||||
```bash
|
||||
poetry install
|
||||
```
|
||||
3. Activate the virtual environment
|
||||
```bash
|
||||
poetry shell
|
||||
```
|
||||
4. Install the pre-commit hooks
|
||||
```bash
|
||||
pre-commit install
|
||||
```
|
||||
5. Copy the `.env.example` file to `.env` and fill in the required values
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
6. Review all useful CLI commands by visiting the [useful CLI commands](docs/CLI.md) file.
|
||||
|
||||
|
||||
## License
|
||||
This project is licensed under the terms of the The Unlicense license. See the [LICENSE](LICENSE.md) file for details.
|
||||
|
|
|
@ -1,7 +1,9 @@
|
|||
## Installation
|
||||
`poetry install` # Install dependencies with Poetry.
|
||||
|
||||
`poetry run pre-commit install` # Install pre-commit hooks.
|
||||
`poetry shell` # Activate the virtual environment.
|
||||
|
||||
`poetry pre-commit install` # Install pre-commit hooks.
|
||||
|
||||
## Development
|
||||
`poetry run python tux/main.py` # Run the application with Poetry.
|
||||
|
|
Loading…
Reference in a new issue