mirror of
https://github.com/FBukovina/Atoll.git
synced 2026-10-27 15:14:33 +00:00
Add README and LICENSE
This commit is contained in:
Ebullioscopic
parent
4517bedc7d
commit
13a32d0567
21 changed files with 247 additions and 24 deletions
193
ReadMe.md
Normal file
193
ReadMe.md
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
Here’s a sample README template for your **Dynamic Island** app project on GitHub. It is organized with detailed sections, a collapsible Table of Contents, and instructions to help users and contributors understand and navigate the project.
|
||||
|
||||
---
|
||||
|
||||
# DynamicIsland
|
||||
|
||||
<p align="center">
|
||||
<img src="https://user-images.githubusercontent.com/ebullioscopic/dynamic-island-logo.png" alt="DynamicIsland Logo" width="200"/>
|
||||
</p>
|
||||
|
||||
> **DynamicIsland** is a macOS app designed for MacBook M3 Pro, crafted to enhance your notch's usability with a dynamic, interactive control center similar to iOS’s Dynamic Island. Built with SwiftUI, Objective-C, and Makefile, this app transforms the notch into a vibrant information hub.
|
||||
|
||||
## 🚀 Features
|
||||
|
||||
- **Music Controls**: Easily manage playback, view album art, and enjoy a music visualizer.
|
||||
- **Battery Indicator**: Track battery status with customizable visuals.
|
||||
- **Calendar Notifications**: Integrate calendar reminders and display event updates.
|
||||
- **Weather Widget**: Get real-time weather updates directly in the notch.
|
||||
- **Multitasking Tools**: Switch between apps, control brightness, and more.
|
||||
- **Highly Customizable**: Tailor the display, gestures, and animations to your preferences.
|
||||
|
||||
---
|
||||
|
||||
<details open>
|
||||
<summary>📑 Table of Contents</summary>
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Basic Controls](#basic-controls)
|
||||
- [Customization Options](#customization-options)
|
||||
- [Configuration](#configuration)
|
||||
- [Theme Settings](#theme-settings)
|
||||
- [Gesture Controls](#gesture-controls)
|
||||
- [Roadmap](#roadmap)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Acknowledgments](#acknowledgments)
|
||||
- [Contributors](#contributors)
|
||||
|
||||
</details>
|
||||
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with **DynamicIsland**, ensure you meet the following prerequisites and have the required dependencies installed.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- macOS Ventura 14.2 or later
|
||||
- Xcode 15.0 or later
|
||||
- A MacBook M3 Pro (or later models with a notch display)
|
||||
|
||||
### Dependencies
|
||||
|
||||
- **SwiftUI**: For building the UI components
|
||||
- **Objective-C**: Used for interoperability with legacy macOS APIs
|
||||
- **Makefile**: For build automation
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone https://github.com/Ebullioscopic/DynamicIsland.git
|
||||
cd DynamicIsland
|
||||
```
|
||||
|
||||
2. **Open the Project in Xcode**:
|
||||
```bash
|
||||
open DynamicIsland.xcodeproj
|
||||
```
|
||||
|
||||
3. **Build and Run**:
|
||||
- Select your target device (MacBook).
|
||||
- Press `Cmd + R` to run the app and see the magic in action.
|
||||
|
||||
4. **Privacy & Security Settings**:
|
||||
- If prompted, go to **Settings > Privacy & Security** and allow the app.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
After launching, **DynamicIsland** will integrate with your MacBook’s notch. The following subsections cover basic controls, customization, and gesture options.
|
||||
|
||||
### Basic Controls
|
||||
|
||||
- **Music Player**: Hover over the notch to access music controls (play, pause, skip).
|
||||
- **Battery Status**: Displays current battery percentage, with low-battery alerts.
|
||||
- **Weather Widget**: Shows real-time weather for your location.
|
||||
- **Multitasking**: Quickly switch between open applications.
|
||||
|
||||
### Customization Options
|
||||
|
||||
1. **Theme**: Choose between **light**, **dark**, and **system** modes.
|
||||
2. **Widget Settings**: Enable/disable widgets based on your preferences.
|
||||
3. **Animations**: Adjust animation speed, delay, and notch expansion effects.
|
||||
4. **Gesture Controls**: See the [Gesture Controls](#gesture-controls) section for details.
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
The `config.json` file in the main directory allows you to personalize your experience further.
|
||||
|
||||
### Theme Settings
|
||||
|
||||
- **`theme`:** Set to `light`, `dark`, or `auto` to match system preferences.
|
||||
- **`accentColor`:** Customize the accent color for UI elements.
|
||||
|
||||
### Gesture Controls
|
||||
|
||||
Define gestures to control various app functions.
|
||||
|
||||
- **Tap Gesture**: Toggles music controls.
|
||||
- **Swipe Left/Right**: Switches between widgets (music, battery, calendar, etc.).
|
||||
- **Long Press**: Opens settings.
|
||||
|
||||
---
|
||||
|
||||
## Roadmap
|
||||
|
||||
This project is continually evolving. Here are some planned features and improvements:
|
||||
|
||||
- [ ] **Expanded App Integration**: Support for third-party app notifications.
|
||||
- [ ] **Customizable App Shortcuts**: Add quick app launchers.
|
||||
- [ ] **Enhanced Calendar Integration**: View entire week schedules.
|
||||
- [ ] **Improved Battery Notifications**: Custom low-battery alerts and battery health info.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Here are some common issues and solutions:
|
||||
|
||||
- **App fails to start**: Ensure you’re running macOS 14.2 or later.
|
||||
- **No permissions prompt**: Go to **System Preferences > Security & Privacy** and manually enable **DynamicIsland**.
|
||||
- **Widgets don’t display correctly**: Restart the app and verify your macOS display settings.
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions from the community! Please follow the steps below:
|
||||
|
||||
1. **Fork the Repository**: Click the "Fork" button at the top of the GitHub page.
|
||||
2. **Clone Your Fork**:
|
||||
```bash
|
||||
git clone https://github.com/yourusername/DynamicIsland.git
|
||||
cd DynamicIsland
|
||||
```
|
||||
3. **Create a New Branch**:
|
||||
```bash
|
||||
git checkout -b feature/YourFeatureName
|
||||
```
|
||||
4. **Make Your Changes** and commit them:
|
||||
```bash
|
||||
git commit -m "Add your message here"
|
||||
```
|
||||
5. **Push to Your Fork**:
|
||||
```bash
|
||||
git push origin feature/YourFeatureName
|
||||
```
|
||||
6. **Submit a Pull Request**: Go to the original repository and click "New Pull Request".
|
||||
|
||||
For major changes, please open an issue first to discuss what you would like to change.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
Special thanks to the **Boring Notch** project for inspiration and the broader open-source community for continuous support.
|
||||
|
||||
---
|
||||
|
||||
## Contributors
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="https://github.com/Ebullioscopic"><img src="https://github.com/Ebullioscopic.png" width="100px;" alt=""/><br /><sub><b>Ebullioscopic</b></sub></a><br />Creator</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue