diff --git a/README.md b/README.md index 7c101bc..a2c797a 100644 --- a/README.md +++ b/README.md @@ -1 +1,45 @@ -# MacOS-Calculator +# MacOS-Calculator 🎛️ + +**MacOS-Calculator** is my attempt to clone Apple's macOS calc. The app utilizes SwiftUI technologies, offering a clean and functional design for basic arithmetic operations. + +## ✨ Features + +- **Basic arithmetic operations**: addition, subtraction, multiplication, division. +- **Functional buttons**: clear, toggle sign, percentage. +- **Sleek UI** with a "frosted glass" effect that matches macOS design guidelines. +- **Keyboard input support**, making it easy to use with the keyboard as well. + +## 🚀 How to Run + +1. **Clone the repository:** + To get started, clone this repository to your local machine: + + ```bash + git clone https://github.com/Guliveer/MacOS-Calculator.git + ``` + +2. **Set up the project:** + Ensure that you have Xcode installed, along with Swift development tools. Open the project in Xcode. + +3. **Run the app:** + Once the project is open in Xcode, press `Cmd + R` to build and run the app on the simulator or a real device. + + ### Or download by clicking [here](https://github.com/Guliveer/MacOS-Calculator/releases/latest/download/release.zip) or through the releases section. + +## 👁️ Take a quick look + +| This | Apple's | +| :-------------------------------------------: | :-------------------------------------------------------: | +| ![My MacOS Calculator](./screenshots/app.png) | ![Apple's MacOS Calculator](./screenshots/apple_calc.png) | + +See the calculator in action! The "frosted glass" effect gives it a clean and polished look, while the button layout ensures smooth interaction. + +## 🖥️ Technologies + +- **Swift** and **SwiftUI**: Using Apple's modern programming language and UI framework, I've tried to replicate the native macOS calculator's functionality, design, and user experience. All that while keeping the codebase clean and maintainable. + +## ⚙️ Future Features + +- **Expanded functionality**: Adding more advanced mathematical operations such as square roots, powers, and logarithms. +- **Dark mode**: Support for system-wide dark/light mode preferences. +- **Customization options**: Ability to personalize the calculator's appearance. diff --git a/screenshots/app.png b/screenshots/app.png new file mode 100644 index 0000000..a03c290 Binary files /dev/null and b/screenshots/app.png differ diff --git a/screenshots/apple_calc.png b/screenshots/apple_calc.png new file mode 100644 index 0000000..f7d7b96 Binary files /dev/null and b/screenshots/apple_calc.png differ