Skip to content

Commit e2b5efe

Browse files
committed
Update readme a bit
1 parent 768fa5d commit e2b5efe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Low-level Haskell bindings to the [BearLibTerminal](http://foo.wyrd.name/en:bear
88

99
### Installing
1010

11-
* This library assumes you have built the main `BearLibTerminal` library (or downloaded the precompiled binaries) and your build tool can find it (e.g. by setting `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`).
11+
* This library assumes you have built the main `BearLibTerminal` library (or downloaded the precompiled binaries available from http://foo.wyrd.name/en:bearlibterminal) and your build tool can find it (e.g. by setting `LD_LIBRARY_PATH` or `DYLD_LIBRARY_PATH`).
1212
* Add `bearlibterminal` to your `*.cabal` `build-depends`.
1313
* Enjoy.
1414

1515
## How can I do things?
1616

17-
This is pretty much a 1-to-1 mapping of the original BLT API, with some marshalling of types and wrappers around function calls that take C strings (these are offered in `CString`, `Text`, and `ByteString` flavours).
17+
This is pretty much a 1-to-1 mapping of the original BLT API, with some marshalling of types and wrappers around function calls that take C strings (these are offered in `CString`, `Text`, and `String` flavours).
1818

1919
Every API call is available as both a raw FFI call (`c_terminal_snake_case`) and as a monadic `MonadIO m => ... m a` function.
2020

2121
Other notes:
22-
- Colours are still simply 4-byte `Word32`s. Higher level colour functions are available in `roguefunctor`.
22+
- Colours are still simply 4-byte `Int`s. Higher level colour functions are available in `roguefunctor`.
2323
- `terminalComposition` takes a `TerminalCompositionMode` rather than raw integers.
24-
- Events read by `terminal_peek`, `terminal_read` are returned as raw integers (`terminalPeekCode`) and as `Event`s (`terminalPeek`).
24+
- Events read by `terminal_peek`, `terminal_read` are returned as raw integers (`terminalPeekCode`) and as `Keycode`s (`terminalPeek`).
2525

2626
## This is a bit too low level for me...
2727

0 commit comments

Comments
 (0)