mirror of
https://github.com/CrystalSplitter/ghcitui.git
synced 2024-09-11 10:55:29 +03:00
Update README.md with more instructions
This commit is contained in:
parent
0343ed4731
commit
2f4827780b
35
README.md
35
README.md
@ -1,5 +1,18 @@
|
||||
# GHCiTUI: Interactive terminal interface for the Glasgow Haskell Compiler
|
||||
|
||||
```
|
||||
/ ______ __ __ ______ __
|
||||
// /\ ___\ /\ \_\ \ /\ ___\ /\_\
|
||||
// ___\ \ \__ \_\ \ __ \_\ \ \_____\ \ \___
|
||||
' , _ // \ \ \_____\ \ \_\ \_\ \ \_____\ \ \_\ \
|
||||
/ \ // 7 \ \/_____/ \/_/\/_/ \/_____/ \/_/ \
|
||||
" \ \ ______ __ __ __ \
|
||||
a a \ /\__ _\ /\ \/\ \ /\ \ \
|
||||
|_ \ \________\/_/\ \/_\ \ \_\ \_\ \ \________\
|
||||
'._ ' \ \_\ \ \_____\ \ \_\
|
||||
(' _ ' \/_/ \/_____/ \/_/
|
||||
```
|
||||
|
||||
This is an experimental front-end terminal interface for
|
||||
`ghci`. It provides a source viewer, keybindings, an interactive
|
||||
interpreter, and a local context viewer.
|
||||
@ -11,6 +24,28 @@ source is the only option.
|
||||
|
||||
See [INSTALLATION.rst](./INSTALL.rst) for details.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Starting the TUI
|
||||
|
||||
GHCiTUI runs a repl in the current directory by default.
|
||||
|
||||
```bash
|
||||
$ cd your/cabal/project/root/directory
|
||||
$ ghcitui
|
||||
```
|
||||
|
||||
You can specify another directory with the `-C <DIR>` flag.
|
||||
|
||||
```bash
|
||||
$ ghcitui -C some/other/directory
|
||||
```
|
||||
|
||||
### Quitting the TUI
|
||||
|
||||
Press `<ESC>` or `q` while in the code viewport panel to quit. While not in the
|
||||
code viewport panel, you may press `<ESC>` to get to the viewport panel.
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributors are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||
|
Loading…
Reference in New Issue
Block a user