1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# curses
[](https://badge.fury.io/rb/curses)
[](https://github.com/ruby/curses/actions?query=workflow%3Aubuntu)
[](https://github.com/ruby/curses/actions?query=workflow%3Awindows)
[](https://github.com/ruby/curses/actions?query=workflow%3Amacos)
* https://github.com/ruby/curses
* https://github.com/ruby/curses/issues
## Description
A Ruby binding for curses, ncurses, and PDCurses.
curses is an extension library for text UI applications.
Formerly part of the Ruby standard library, [curses was removed and placed in this gem][1]
with the release of Ruby 2.1.0. (see [ruby/ruby@9c5b2fd][2])
## Install
$ gem install curses
Requires ncurses or ncursesw (with wide character support).
On Debian based distributions, you can install it with apt:
$ apt install libncurses5-dev
Or
$ apt install libncursesw5-dev
On Windows, `gem install curses` will build bundled PDCurses, so you
don't need to install extra libraries.
However, if you prefer ncurses to PDCurses, specify the following option:
> gem install curses -- --use-system-libraries
On mingw, you need DevKit to compile the extension library.
On MacOS, `ncurses` menu isn't natively supported. You can install the gem with menu support using homebrew:
brew install ncurses
gem install curses -- --use-system-libraries --with-ncurses-dir=/usr/local/opt/ncurses
_with `/usr/local/opt/ncurses` the path where homebrew installed ncurses on your machine_
## Documentation
See [https://www.rubydoc.info/gems/curses](https://www.rubydoc.info/gems/curses).
## Developers
After checking out the repo, run `bundle install` to install dependencies.
To compile the extension library, run `bundle exec rake compile`.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `curses.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## License
curses is released under the Ruby and 2-clause BSD licenses. See COPYING for
details.
It includes a forked version of PDCurses, which is in the public domain:
https://github.com/Bill-Gray/PDCurses
The version for Win32 console mode in the wincon subdirectory is used.
[1]: https://bugs.ruby-lang.org/issues/8584
[2]: https://github.com/ruby/ruby/commit/9c5b2fd8aa0fd343ad094d47a638cfd3f6ae0a81
|
