diakonos/README.rdoc

86 lines
1.8 KiB
Plaintext
Raw Normal View History

= Diakonos
2004-08-19 22:32:34 +02:00
== REQUIREMENTS
2009-03-08 12:58:09 +01:00
2018-02-20 18:27:18 +01:00
- Ruby 2.3+
- curses gem
2009-03-08 12:58:09 +01:00
Diakonos is built to run on Linux, but may run under other flavours of UNIX.
It works reasonably well under iTerm on OSX. It may or may not work on Windows.
Under Debian and Ubuntu derivatives, you'll need the following dependencies:
2023-07-06 15:41:37 +02:00
sudo apt-get install libncurses5-dev ruby-dev ruby-curses
== INSTALLATION
gem install diakonos
2011-04-29 19:02:08 +02:00
=== RVM
If you use RVM[1], `gem install diakonos` will only install with the current
Ruby version and gemset. Diakonos may no longer be in the PATH after switching
Ruby versions or gemsets.
To make Diakonos available when it isn't installed in the current gemset, first
install it into an RVM Ruby version of your choice (and gemset, if you wish).
Then add a script like this in a directory in your PATH (such as
`~/bin/diakonos`):
#!/bin/zsh
2010-08-26 15:14:52 +02:00
source "$HOME/.rvm/scripts/rvm"
rvm use 3.0.0@your-gemset
diakonos
2011-04-29 19:02:08 +02:00
and make the script executable:
2011-04-29 19:02:08 +02:00
chmod +x ~/bin/diakonos
2011-04-29 19:02:08 +02:00
[1]: https://rvm.io
2010-08-26 15:14:52 +02:00
== SOURCE CODE
The latest development code can be obtained from sourcehut:
git clone https://git.sr.ht/~pistos/diakonos
== UNINSTALLATION
gem uninstall diakonos
2004-08-19 22:32:34 +02:00
== USAGE
2009-03-08 12:41:12 +01:00
Run with any of these:
2010-08-26 15:15:03 +02:00
diakonos [filename...]
2011-08-08 03:11:58 +02:00
diakonos -s <session-name>
2009-03-08 12:41:12 +01:00
diakonos -m <regexp>
or, for other options and arguments,
2009-02-14 06:00:16 +01:00
diakonos --help
2009-03-08 12:41:12 +01:00
For help using Diakonos, simply press F1 or Shift-F1 from within the editor to
use the interactive help system.
To dig deeper into Diakonos' rich feature set, see https://github.com/Pistos/diakonos/wiki/Beyond-the-Basics .
2006-05-13 21:10:34 +02:00
2008-05-20 20:52:18 +02:00
----------------------------------------------------------------
2021-05-28 19:12:49 +02:00
Send comments, feedback and tech support requests to the ##pistos channel on
the Libera IRC network.
2022-03-22 19:04:30 +01:00
Reproducible issues may be reported at https://todo.sr.ht/~pistos/diakonos or
https://github.com/Pistos/diakonos/issues .
2004-08-19 22:32:34 +02:00
Pistos