CoBiE/README.md
2025-06-20 16:25:21 +02:00

94 lines
3.5 KiB
Markdown

# CoBiE Time System Calendar
An interactive web app that visualizes the **CosmoChron Binary Epoch (CoBiE)** time system alongside standard UTC/TAI clocks, complete with an explorable calendar of “Eonstrip” periods and detailed breakdowns of cosmic time units.
## Features
- **Live CoBiE Clock**: Displays the current CoBiE timestamp, updating every second.
- **Analog Clock**: Full-screen clock with 16 hex markers and CoBiE hands.
- **UTC & TAI Display**: Shows both UTC and International Atomic Time (TAI) in human-readable format.
- **Timezone Selector**: Switch between UTC, TAI, or any IANA timezone.
- **Interactive Calendar**: Browse past and future Megasequences and Eonstrips with Prev/Next controls.
- **Tooltips**: Hover or click on an Eonstrip card to see start/end times and duration.
- **Manual Mode**: Enter any CoBiE timestamp to compare and calculate differences.
- **Time Breakdown**: View core units (Galactic Year → Second) and optional extended units (Astralmillennia → Universal Eon).
- **Responsive Design**: Adapts to mobile viewports with font scaling.
- **Modern UI**: Glassmorphism, gradient text, animated hover effects, and CSS-backed glows.
## Getting Started
### Prerequisites
- A modern web browser (Chrome, Firefox, Edge, Safari).
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/your-username/cobie-time-system.git
cd cobie-time-system
```
2. **Open in browser**
Simply open `index.html` in your preferred browser:
```bash
open index.html
```
or double-click the file in your file manager.
## Usage
* **Live View**: On load, the app shows the current CoBiE time, UTC, and TAI.
* **Navigate Periods**:
* ← / → buttons to move by Megasequence (hold modifier keys for larger jumps).
* Swipe left/right (touch, mouse drag, or horizontal scroll) to perform the same navigation.
* “Now” button to return to live mode.
* **Manual Mode**: Click the CoBiE time to enter an arbitrary timestamp; press Enter or click elsewhere to apply.
* **Compare Mode**: In manual mode, click the “Compare” field to set a second timestamp for difference calculations.
* **Toggle Units**: Use “Show Cosmic Units” to reveal extended time units.
## Project Structure
```
├── index.html # Main HTML markup
├── clock.js # Clock logic
├── cobie.js # CoBiE time system utilities
├── utils.js # Generic helper functions
├── animate.js # Shared animations
├── events.js # Sample calendar events
├── style.css # Separated styles
├── script.js # Page interactions
├── README.md # This documentation
└── test/ # Unit tests
```
## macOS Widget
The repository provides a SwiftUI widget inside the Xcode project
located at `CoBiE/CoBiE.xcodeproj`.
1. Open the project in Xcode.
2. Select the `CoBiE Analog Clock` scheme.
3. Build and run to install the widget on macOS 13 or later.
The widget displays the analog CoBiE clock directly on your desktop or
in Notification Center.
## Contributing
1. Fork the repository.
2. Create your feature branch: `git checkout -b feature/YourFeature`.
3. Commit your changes: `git commit -m "Add YourFeature"`.
4. Push to the branch: `git push origin feature/YourFeature`.
5. Submit a Pull Request.
Please follow standard JavaScript style and include comments for new functionality.
## License
This project is released under the [WTFPL](LICENSE).
Feel free to use, modify, and distribute!