summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b166132
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# curses
+
+* 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
+
+## Developers
+
+After checking out the source, run:
+
+ $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+## License
+
+curses is released under the Ruby and 2-clause BSD licenses. See COPYING for
+details.
+
+[1]: https://bugs.ruby-lang.org/issues/8584
+[2]: https://github.com/ruby/ruby/commit/9c5b2fd8aa0fd343ad094d47a638cfd3f6ae0a81