docs/design: new design by BYTEMALTE and Docs
This commit is contained in:
68
README.md
68
README.md
@@ -1,60 +1,56 @@
|
||||
# mcalc - Simple Dioxus Calculator
|
||||
|
||||
A simple, modern, and beautiful calculator application built with Rust and Dioxus.
|
||||
|
||||
## Description
|
||||
|
||||
**mcalc** is a lightweight desktop calculator that demonstrates how to build a clean UI with state management in Dioxus. It features a modern dark mode design with glassmorphism effects and responsiveness.
|
||||
A simple calculator application built with Rust and Dioxus, featuring the BYTEMALTE design system.
|
||||
|
||||
## Features
|
||||
|
||||
- **Basic Arithmetic**: Addition, Subtraction, Multiplication, Division.
|
||||
- **Modern UI**: Clean typography, glassmorphism card, and neon accents.
|
||||
- **Interactive**: Hover effects and smooth animations.
|
||||
- **Responsive**: Adapts to window resizing.
|
||||
- Basic Arithmetic: Addition, Subtraction, Multiplication, Division
|
||||
- Clean UI with BYTEMALTE design system (dark theme)
|
||||
- Desktop and Web support
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Rust**: Core logic and safety.
|
||||
- **Dioxus**: UI framework (React-like for Rust).
|
||||
- **CSS3**: Custom styling with variables and flexbox/grid.
|
||||
- **Rust**: Core logic and safety
|
||||
- **Dioxus 0.7**: UI framework (React-like for Rust)
|
||||
- **CSS3**: Custom styling with variables and flexbox/grid
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Rust](https://www.rust-lang.org/tools/install) installed.
|
||||
- [Dioxus CLI](https://dioxuslabs.com/learn/0.6/getting_started) (optional but recommended for development).
|
||||
|
||||
```bash
|
||||
cargo install dioxus-cli
|
||||
```
|
||||
- [Rust](https://www.rust-lang.org/tools/install) installed
|
||||
|
||||
### Running the App
|
||||
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone <repository_url>
|
||||
cd mcalc
|
||||
```
|
||||
```bash
|
||||
# Desktop
|
||||
cargo run
|
||||
|
||||
2. **Run with Cargo**:
|
||||
```bash
|
||||
cargo run
|
||||
```
|
||||
# Web
|
||||
cargo run --features web
|
||||
```
|
||||
|
||||
**Or with Dioxus CLI (for hot reloading):**
|
||||
```bash
|
||||
dx serve
|
||||
```
|
||||
### Building
|
||||
|
||||
```bash
|
||||
# Debug build
|
||||
cargo build
|
||||
|
||||
# Release build
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
- `src/main.rs`: Entry point.
|
||||
- `src/ui.rs`: Main calculator UI and logic calls.
|
||||
- `assets/main.css`: Styling and themes.
|
||||
- `src/logic.rs`: Calculator logic.
|
||||
```
|
||||
src/
|
||||
main.rs # App entry point
|
||||
ui.rs # Calculator UI components
|
||||
logic.rs # Calculator business logic
|
||||
assets/
|
||||
main.css # Global styles (BYTEMALTE design system)
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
GPL-3 License
|
||||
GPL-3 License
|
||||
|
||||
Reference in New Issue
Block a user