Merge pull request #26 from lukaszgemborowski/issue-1-readme

[readme] create initial readme
lukaszgemborowski · Dec 15, 2019 · e104281 · e104281
2 parents ad5b123 + 32ad1fb
commit e104281
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# ncurses++
+
+ncurses++ is an attempt to create high-level C++ interface for old and good ncurses library.
+
+## Functionality
+
+ - horizontal and vertical layouts
+ - colors
+ - static text
+ - attributes
+
+## Building
+
+To build ncurses++ you need a compiler supporting C++17, cmake and ncurses.
+
+1. mkdir build
+2. cd build
+3. cmake ..
+4. make
+
+## Examples
+
+See: examples/gallery/