refactor: new start

README.md

@@ -1,9 +1,9 @@
-# ⏰ Floating Clock
+# ⏰ Flock
 
 ![code size](https://img.shields.io/github/languages/code-size/ivaquero/floating-clock.svg)
 ![repo size](https://img.shields.io/github/repo-size/ivaquero/floating-clock.svg)
 
-This project aims to build a cross-platform floating clock based on PySide6 & Qt6.
+This project aims to build a cross-platform floating clock based on Qt6.
 
 ## Motivation
 
@@ -12,28 +12,108 @@ When on macOS / Linux, the clock on the menu bar is too small to be noticeable,
 
 ![clock](doc/clock.png)
 
-## Roadmap
+## ✨ Features
 
-- [ ] Main Window
-  - [x] Frameless
+- [ ] **Main Window**
+  - [ ] Frameless
   - [x] Drag and Move
   - [x] Right Click Menu
-  - [x] Always On Top
+  - [ ] Always On Top
   - [ ] Show in Fullscreen Mode
-- [x] Font
-  - [x] Set Color
+- [x] **Style**
   - [x] Set Background Color
-  - [x] Change Size
-- [x] Configuratin File
-  - [x] Read Settings
-  - [x] Write Settings
-  - [x] Reset Settings
-- [ ] Time
+  - [x] Set Font Color
+  - [x] Set FontSize
+- [ ] **Configuration File** (XML)
+  - [ ] Read Settings
+  - [ ] Write Settings
+  - [ ] Reset Settings
+- [ ] **Time**
   - [ ] Select Time Zone
   - [ ] Set Alarms
 
-## For Testing
+## Quick Start
 
-```python
-python -m pip install -r requirements.txt
+### Build and Run
+
+#### Quick Build (Recommended)
+
+```bash
+# One-click build
+./build.sh
+
+# Run application
+./build/flock.app/Contents/MacOS/flock  # macOS
+./build/flock                           # Linux
 ```
+
+#### Manual Build
+
+```bash
+# Clean build files
+./clean.sh
+
+# Generate Makefile
+qmake flock.pro
+
+# Build
+make
+
+# Run
+./build/flock.app/Contents/MacOS/flock  # macOS
+./build/flock                             # Linux
+```
+
+#### Using CMake
+
+```bash
+mkdir build && cd build
+cmake ..
+make
+./flock
+```
+
+### Usage
+
+- **Move**: Left-click and drag
+- **Menu**: Right-click for context menu
+- **Customize**: Change colors, font size, always-on-top behavior
+
+### Project Structure
+
+```text
+qflock/
+├── build/                    # Build output directory
+│   ├── flock.app/           # macOS application bundle
+│   ├── *.o                   # Object files
+│   ├── moc_*.cpp            # Qt meta-object compiler output
+│   └── Makefile             # Build file
+├── build.sh                 # One-click build script
+├── clean.sh                 # Clean script
+├── flock.pro                # qmake project file
+├── CMakeLists.txt           # CMake project file
+└── README.md
+```
+
+### Build Output Management
+
+- All compilation files (.o, moc_*.cpp, Makefile, etc.) are output to `build/` directory
+- Executable files are located at `build/flock.app/Contents/MacOS/flock` (macOS) or `build/flock` (Linux)
+- Use `./clean.sh` to quickly clean all build files
+- Use `./build.sh` for complete one-click build
+
+### Next Steps
+
+- Time zone selection
+- Alarm functionality
+- Enhanced UI/UX
+
+## Requirements
+
+- Qt6 (Core, Widgets)
+- C++17 compatible compiler
+- CMake 3.16+ (optional, for CMake build)
+
+## License
+
+See LICENSE file for details.