Permalink
Browse files

Added note about fix for users with unknown/unrecognized terminals (e…

…specially OSX Terminal.app users).
  • Loading branch information...
1 parent 9bf36bf commit d86f365d2296ede6db2fe81b1c57fbd157510961 @mscdex committed Aug 23, 2010
Showing with 18 additions and 8 deletions.
  1. +17 −7 README.md
  2. +1 −1 package.json
View
@@ -1,22 +1,32 @@
Description
===========
-node-ncurses is an ncurses++ binding for [node.js](http://nodejs.org/).
+node-ncurses is an ncurses binding for [node.js](http://nodejs.org/).
Requirements
============
-* [node.js](http://nodejs.org/) -- tested with v0.1.94
-* ncurses (with the C++ binding built and installed) and ncurses development headers installed -- tested with 5.7
+* [node.js](http://nodejs.org/) -- v0.1.94+
+* A compatible terminal (OSX users see the note below)
-If you don't have ncurses++ installed, you'll get build errors including:
+To build node-curses:
- ../ncurses.cc:9:21: error: cursesp.h: No such file or directory
+ node-waf configure build
-To build node-curses:
- node-waf configure build
+Special note for unknown terminals
+==================================
+
+If your terminal is not in terminfo's database, you'll get this error while attempting to execute any of the node-ncurses examples: "Error opening terminal: xxxxx."
+This error has been known to at least occur on OSX 10.6.* with the default Terminal.app. The fix for this is to add your terminal to the terminfo database like so:
+
+ mkdir ~/.terminfo
+ infocmp -L > foo
+ tic foo
+ rm foo
+
+If no errors occurred while executing those commands, then you are all set and should be able to execute node-ncurses examples now. If not, send me a message and let me know.
Terminology
View
@@ -1,6 +1,6 @@
{ "name" : "ncurses"
, "version" : "0.0.1"
-, "author" : "Brian White <mscdex@gmail.com>"
+, "author" : "Brian White <mscdex@mscdex.net>"
, "description" : "An ncurses binding for node.js"
, "scripts" : { "preinstall" : "node-waf configure build" }
, "main" : "./ncurses"

0 comments on commit d86f365

Please sign in to comment.