Skip to content

Commit

Permalink
improve readme install section
Browse files Browse the repository at this point in the history
  • Loading branch information
soywod committed Dec 15, 2020
1 parent d3fe432 commit 026ed63
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 10 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Installation script

### Changed

- README.md [#8]

### Fixed

- Use OS specific `tmp` and `xdg` dirs [#3]

[unreleased]: https://github.com/soywod/comodoro

[#3]: https://github.com/soywod/comodoro/issues/3
[#8]: https://github.com/soywod/comodoro/issues/8
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ in [OCaml](https://ocaml.org/index.fr.html).
* [Usage](#usage)
* [Start](#start)
* [Stop](#stop)
* [Run](#run)
* [Watch](#watch)
* [Contributing](#contributing)
* [Changelog](https://github.com/soywod/comodoro/blob/master/CHANGELOG.md#changelog)
Expand Down Expand Up @@ -49,7 +48,26 @@ section](https://github.com/soywod/comodoro/releases).*

### From sources

TODO
First install [`opam`](https://opam.ocaml.org/):

```bash
sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)
```

Then build from sources:

```bash
git clone https://github.com/soywod/comodoro.git
cd comodoro
opam install .
```

The executable is available at `_build/default/bin/main.exe`. To have globally
access you can link it this way:

```bash
ln -s `pwd`/_build/default/bin/main.exe /usr/local/bin/comodoro
```

### Completion

Expand All @@ -69,6 +87,8 @@ exec-on-break = ["notify-send Comodoro 'BREAK TIME'"]
exec-on-resume = ["notify-send Comodoro 'WORK TIME'"]
```

*Note: `$XDG_CONFIG_HOME` is usually set to `~/.config`.*

*Note: read more about the TOML file format
[here](https://github.com/toml-lang/toml).*

Expand All @@ -90,14 +110,6 @@ Stop the timer.
comodoro stop
```

### Run

Run the timer loop (blocking).

```bash
comodoro run
```

### Watch

Watch the timer (blocking).
Expand Down

0 comments on commit 026ed63

Please sign in to comment.