From 785ebc26553619cb69ce57be9053670c387fe109 Mon Sep 17 00:00:00 2001 From: tretrauit Date: Fri, 5 Jan 2024 01:35:48 +0700 Subject: [PATCH] chore: add some info to the README --- README.md | 48 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 32 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 28e0164..62cc052 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,47 @@ An open-source bot which helps you to choose best swords for fishes around the world. +## Features + ++ Faster than Leg (hopefully) ++ Written in Rust ++ Open source ++ ... more in the future + ## Usage TODO:tm: ## Installation -1. Clone the repository. -2. Install Tesseract -> Tesseract works on Linux way better than Windows, but oh well. +1. Install required dependencies (Tesseract, MongoDB) + + There are various way to install them, but so far on Arch Linux you would execute the following commands: + ```bash + sudo pacman -S tesseract tesseract-data-eng + yay -S mongodb-bin + # Optional + yay -S mongodb-compass # Manage the database with a GUI + ``` + > Tesseract works on Linux way better than Windows, but oh well. +2. Clone the repository. 3. Set up your MongoDB database. -> The free tier in MongoDB Atlas is NOT enough as it is limited to 500 entries only. + > The free tier in MongoDB Atlas is NOT enough as it is limited to 500 entries only. 4. Set up the required environment variables, which contains these variables: -```bash -# Putting all of these into a .env file is fine. -DISCORD_TOKEN= -MONGODB_URL= -# Optional, only if the url doesn't contain a username. -MONGODB_USERNAME= -# Optional, only if the url doesn't contain a password. -MONGODB_PASSWORD= -``` + + ```bash + # Putting all of these into a .env file is fine. + DISCORD_TOKEN= + MONGODB_URL= + # Optional, only if the url doesn't contain a username. + MONGODB_USERNAME= + # Optional, only if the url doesn't contain a password. + MONGODB_PASSWORD= + ``` 5. Start the bot: -```bash -cargo run -``` + ```bash + cargo run + ``` ## FAQ