From 84f375c564d232dc68b3c8d4a0240d4bda0a4799 Mon Sep 17 00:00:00 2001 From: Rik Heijmann Date: Fri, 28 Feb 2025 22:11:03 +0100 Subject: [PATCH] Added the installation guides to the README.md. --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 26aa341..2b3929d 100644 --- a/README.md +++ b/README.md @@ -159,18 +159,14 @@ Each folder has a detailed README.md file which explains the folder in more deta | GET | `/todos/{id}` | ✅ | 🚫 | Get a todo by ID. | | DELETE | `/todos/{id}` | ✅ | 🚫 | Delete a todo by ID. | -## 📦 Installation & Usage -```bash -# Clone and setup -git clone https://github.com/Riktastic/Axium.git -cd Axium && cp .env.example .env +## 📦 Installation & usage +To get started with Axium, you'll need to install it on your system. We provide detailed installation guides for different environments: -# Database setup -sqlx database create && sqlx migrate run +- **Docker setup**: Follow the instructions in [Docker Setup Guide](/documentation/installation_docker.md) to run Axium using Docker Compose. +- **Ubuntu setup**: For users on Ubuntu or other Debian-based systems, refer to the [Ubuntu Setup Guide](/documentation/installation_ubuntu.md). +- **Windows setup**: Windows users can find their setup instructions in the [Windows Setup Guide](/documentation/installation_windows.md). -# Start server -cargo run --release -``` +These guides cover cloning the repository, setting up the environment, configuring the database, and running the application. ### 🔐 Default accounts