Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
damianfral committed Oct 22, 2023
1 parent 5c9121a commit 2c41b43
Showing 1 changed file with 47 additions and 22 deletions.
69 changes: 47 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,47 @@
# Nix flake for a Haskell CLI application

This flake contains a Nix package and a development shell for a sample Haskell
CLI application called `hello`.

The Haskell package is wrapped with `generateOptparseApplicativeCompletions`,
which adds shell completion scripts. These scripts will be automatically picked
up if the resulting derivation is installed.

The development shell provides the following tools for Haskell development:

- [cabal-install](https://www.haskell.org/cabal/)
- [haskell-language-server](https://github.com/haskell/haskell-language-server)
- [ghcid](https://github.com/ndmitchell/ghcid)
- [pre-commit-hooks.nix](https://github.com/cachix/pre-commit-hooks.nix)
- [actionlint](https://github.com/rhysd/actionlint)
- [hlint](https://github.com/ndmitchell/hlint)
- [hpack](https://github.com/sol/hpack)
- [nil](https://github.com/oxalica/nil)
- [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)
- [ormolu](https://github.com/tweag/ormolu)
- [statix](https://github.com/nerdypeppercom/jez/statix)
# TIL - Today I Log

`til` is a TUI for a markdown logbook/diary.

## Run

```shell
nix run github:damianfral/til
```

### Options

```text
til v0.0.0.1
Usage: til [--directory STRING] [--editor STRING]
Available options:
-h,--help Show this help text
--directory STRING Log directory (default: "./")
--editor STRING Editor to open markdown files (default: "vi")
```

### Keybindings

| Keybinding | Description |
| ---------- | ----------- |
| `Esc` | exit |
| `q` | exit |
| `h` | help |
| `r` | refresh current entry |
| `J` | select day before |
| `K` | select day after |
| `j` | increase scroll |
| `k` | decrease scroll |
| `e` | edit entry |

## Home Manager module

```nix
home-manager.users.my-user = {
imports = [inputs.til.homeManagerModules.default];
programs.til.enable = true;
programs.til.directory = "~/code/journal";
programs.til.editor = "nvim";
}
```

0 comments on commit 2c41b43

Please sign in to comment.