https://github.com/konstantine-v/cycling-data
Program for logging cycling data, either manually or from AAT
https://github.com/konstantine-v/cycling-data
crystal crystal-lang crystal-language cycling
Last synced: 12 months ago
JSON representation
Program for logging cycling data, either manually or from AAT
- Host: GitHub
- URL: https://github.com/konstantine-v/cycling-data
- Owner: konstantine-v
- License: mit
- Created: 2020-09-25T02:13:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-25T02:37:33.000Z (over 5 years ago)
- Last Synced: 2025-02-05T21:27:34.673Z (about 1 year ago)
- Topics: crystal, crystal-lang, crystal-language, cycling
- Language: Crystal
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cycling Data
Consume Cycling data from rides then parse said data into CSV file for use with other programs.
Cycles -> Records Ride Data (time, distance, etc) -> Store Data in CSV -> Access Data
Created as a means to solve my simple problem of entering cycling and training data offline and quickly without fuss on any device that can run a terminal emulator.
## Installation
To install the program run use the crystal compiler to handle it.
``` sh
$ crystal build src/cycling.cr --release
```
~~You can optionally use Cake in the directory to compile. Cake is a version of a Makefile specifically for Crystal projects.~~
Just use `make` as it's consistant and doesn't require any 3rd party binary.
``` sh
$ make
```
If you're not familiar with building programs in Crystal or want to know more refer to the [using the compiler section of the crystal docs](https://crystal-lang.org/reference/using_the_compiler/#crystal-build).
## Usage
I wanted it to be simple and not get in the way, so simply running `cycling` should work.
``` sh
$ cycling
```
### Changing File Output
If you want the program to create a new file in a particular place within your filesystem specify it with the `-f` flag
``` sh
$ cycling -f
```
or
``` sh
$ cycling --file
```
### Getting Help
The program accepts flags, use `-h` to read about them.
``` sh
$ cycling -h
```
or
``` sh
$ cycling --help
```
### Other Flags
I want to add more flags so you can import data from AAT and output into stdout for piping in the console.
I would love to see this work with GnuPlot to create charts in the console, or export to JSON to be used with web programs.
## Development
No shard dependencies used, but make sure your version of crystal is up to date.
All development happens in the `src/` directory.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Konstantine](https://materialfuture.net) - creator and maintainer