Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ornitorink0/coolclock
A Way to Flex the Clock on Linux
https://github.com/ornitorink0/coolclock
clock cool ncurses ncurses-library ncurses-ui shell terminal terminal-colors terminal-ui time watch
Last synced: 15 days ago
JSON representation
A Way to Flex the Clock on Linux
- Host: GitHub
- URL: https://github.com/ornitorink0/coolclock
- Owner: Ornitorink0
- License: mit
- Created: 2024-12-02T18:19:34.000Z (20 days ago)
- Default Branch: main
- Last Pushed: 2024-12-03T16:12:35.000Z (19 days ago)
- Last Synced: 2024-12-03T16:39:39.715Z (19 days ago)
- Topics: clock, cool, ncurses, ncurses-library, ncurses-ui, shell, terminal, terminal-colors, terminal-ui, time, watch
- Language: C++
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CoolClock
CoolClock is a C++ program that displays the current time in an ASCII art style using pre-created fonts. It runs on Linux systems (specifically tested on Arch Linux) and leverages the `ncurses` library to manage terminal output. Users can toggle between different fonts for the clock by pressing the 'w' key and can exit the program by pressing 'q'.
## Features
- Displays the current time in ASCII art.
- Allows switching between different clock fonts.
- Simple terminal interface using `ncurses`.
- Dynamic adjustment for terminal window size.
- Color schemes.
## Prerequisites
- **C++ Compiler** (e.g., `g++`)
- **ncurses Library**
- On Arch Linux, you can install it using:
`sudo pacman -S ncurses`
- **Make** (for building the project)
### Installation and Uninstallation
To install the program, run the following command in the project directory (replace `sudo` with `su` if needed):
```bash
sudo make install
```
This command will install the program and its dependencies on the system.
#### Uninstallation
To uninstall the program, run the following command in the project directory:
```bash
sudo make uninstall
```
This command will remove the program and its dependencies from the system.
## Cloning and Building
1. Clone the repository:
```bash
git clone https://github.com/yourusername/CoolClock.git
cd CoolClock
```
2. Build the project:
```bash
make build
```
This will create the `coolclock` executable in the current directory and will clean previous build files.
3. Run the program:
```bash
./coolclock
```
> Please clean up the project directory after use by running `make clean`.
## Usage
Once the program is installed, you can run it using the following command:
```bash
coolclock
```
The current time will be displayed in a pre-defined ASCII art font. The available features are:
- **Change Font**: Press `w` or `W` to cycle through different ASCII art fonts.
- **Change Color**: Press `c` to cycle through different color schemes.
- **Quit**: Press `q` or `Q` to exit the program.
**Note**: The program requires a terminal window with at least 6 lines and 55 columns.
## Collaboration
We are open to contributions! Feel free to fork the repository, submit issues, and create pull requests.
### How to contribute:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes and commit them (`git commit -am 'Add new feature'`).
4. Push to your branch (`git push origin feature-branch`).
5. Open a pull request with a description of the changes.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Acknowledgments
- `ncurses` library for handling terminal graphics.
- Pre-created ASCII art fonts for time display.
## Author
- [Ornitorink0](https://github.com/Ornitorink0)
> Please note that this project is for educational purposes only and is not intended for commercial use. I do not take responsibility for any legal issues that may arise from its use. I am a beginner, so please be patient and understanding. Your feedback is welcome.