https://github.com/jeffa5/owork

A productivity timer in OCaml
https://github.com/jeffa5/owork

Last synced: 23 days ago
JSON representation

A productivity timer in OCaml

• Host: GitHub
• URL: https://github.com/jeffa5/owork
• Owner: jeffa5
• License: gpl-3.0
• Created: 2019-03-26T18:26:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T20:54:53.000Z (about 1 year ago)
• Last Synced: 2023-10-18T21:39:35.639Z (about 1 year ago)
• Language: OCaml
• Homepage:
• Size: 67.4 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# owork

An OCaml implementation of a productivity timer. There is a server component at the moment which accepts connections over a Unix socket. The timer can then be started, paused/resumed, reset and sessions restarted.

## Install

To install the program, first clone the repo and then run `make install` (Note: `opam` may be required to install necessary packages):

```sh

git clone https://github.com/jeffa5/owork.git

cd owork

make install

owork --help

```

## Socket file

The default socket file is created at `/tmp/owork.sock`. This can be overridden with a command-line option.

## Protocol

The protocol is outlined in [PROTOCOL.md](PROTOCOL.md)

## Examples

Some example client scripts to interact with the server can be found in the `examples` directory.