Browse files

modified README

  • Loading branch information...
kikito committed May 15, 2011
1 parent dd4c414 commit 625baf8d272eed9d39ac279d51691205293da995
Showing with 13 additions and 0 deletions.
  1. +13 −0 README.textile
@@ -20,6 +20,19 @@ h2. Usage
print(colors('%{bright red underlined}hello'))
+h2. Testing
+This application uses telescope in order to perform the tests. Install telescope, and then execute
+ tsc specs/ansicolors_spec.lua
+Notice that the tests will only work on an ANSI-compatible machine (windows isn't ANSI-compatible)
+h2. Windows
+Windows console, by default, isn't capable of handling ANSI color codes correctly. This library tries to detect whether it is on a windows machine (by looking at package.path) and in that case it suppresses all ANSI control characters (the text appears devoid of color, but legible).
h2. Valid attribute list:
Misc. attributes:

0 comments on commit 625baf8

Please sign in to comment.