diff --git a/README.md b/README.md index 1e629b6..8cfe9e0 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,64 @@ -# Development +# mdo - Modern Dioxus To-Do -Your new bare-bones project includes minimal organization with a single `main.rs` file and a few assets. +A sleek, minimalistic, and modern To-Do application built with **Rust** and **Dioxus**. +Designed with a focus on clean aesthetics and smooth user interactions. -``` -project/ -├─ assets/ # Any assets that are used by the app should be placed here -├─ src/ -│ ├─ main.rs # main.rs is the entry point to your application and currently contains all components for the app -├─ Cargo.toml # The Cargo.toml file defines the dependencies and feature flags for your project -``` +## ✨ Features -### Serving Your App +- **Modern UI**: Clean dark mode design with glassmorphism-inspired elements. +- **Interactive**: Smooth hover animations and responsive feedback. +- **Fast**: Built on Rust for high performance and reliability. +- **Simple Workflow**: easily add and remove tasks throughout your day. -Run the following command in the root of your project to start developing with the default platform: +## 🛠️ Tech Stack + +- **Framework**: [Dioxus](https://dioxuslabs.com/) (Rust) +- **Styling**: Custom CSS (Modern, Dark Theme) +- **Language**: Rust 🦀 + +## 🚀 Getting Started + +### Prerequisites + +Ensure you have Rust and the Dioxus CLI installed. ```bash +# Install Rust +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + +# Install Dioxus CLI +cargo install dioxus-cli +``` + +### Running the App + +Clone the repository and run the development server: + +```bash +# Clone the project (if you haven't already) +# git clone ... + +# Navigate to the project directory +cd mdo + +# Serve the application dx serve ``` -To run for a different platform, use the `--platform platform` flag. E.g. +To run as a desktop application: + ```bash dx serve --platform desktop ``` +## 🎨 Project Structure + +``` +project/ +├─ assets/ # CSS styles and static resources +│ └─ main.css # Global styles and themes +├─ src/ +│ ├─ main.rs # Application entry point +│ └─ ui.rs # UI Components (Hero, To-Do List) +├─ Cargo.toml # Dependencies +``` \ No newline at end of file