Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/giraugh/pi-time

🥧 Countdown until pi time
https://github.com/giraugh/pi-time

cli-tool pi rust

Last synced: 25 days ago
JSON representation

🥧 Countdown until pi time

Host: GitHub
URL: https://github.com/giraugh/pi-time
Owner: giraugh
License: mit
Created: 2022-10-04T04:16:53.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-10-04T06:06:08.000Z (over 2 years ago)
Last Synced: 2024-12-23T06:41:43.485Z (29 days ago)
Topics: cli-tool, pi, rust
Language: Rust
Homepage:
Size: 4.88 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 🥧 Pi-Time
We all know pi time is the best time, but when is it? Use this cli-tool to quickly find out and never miss out on pi time again.

## Usage
Running the `pi-time` binary will output either "Its pi time" or the remaining time until pi time. Run with `-h` to view other options.

```
> pi-time
10h 28m 42s until pi time
```

## Installation
You can install `pi-time` on mac using homebrew.
```
brew tap giraugh/giraugh
brew install pi-time
```

## Building
Building pi-time requires a copy of the rust compiler. You can install it using the rust toolchain available [here](https://www.rust-lang.org/tools/install).

1. Clone locally

```bash
git clone https://github.com/giraugh/pi-time
```
2. Build the crate

```bash
cd pi-time
cargo build
```
3. Optionally, install `pi-time` to your PATH.

```
cargo install --path .
```

## Contributing
If you encounter any issues or bugs, please leave an issue on Github. Additionally, all and any PRs are welcome :)