added license and basic "read me" information

Gentoo
Christian Burger 2022-04-05 10:24:22 +02:00
parent c0a3ca7822
commit e9ef61f7ae
3 changed files with 44 additions and 1 deletions

View File

@ -52,6 +52,7 @@
"iomanip": "cpp",
"iostream": "cpp",
"stdexcept": "cpp",
"typeinfo": "cpp"
"typeinfo": "cpp",
"pointers": "cpp"
}
}

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Christian Burger <christian@krikkel.de>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

21
README.md Normal file
View File

@ -0,0 +1,21 @@
## Description
**WARNING**: This is a prototype. Things will probably break; in spectacular
ways.
`NCursesPty` provides a pseudo terminal in a ncurses window.
## Building
Requires:
* GCC 9.3 (C++17)
* ncurses 6.2
* libvterm (0.1.2-2; r740 at https://bazaar.launchpad.net/~libvterm/libvterm/trunk/revision/740)
* libmsgsl-dev 2.1.0-1 (Microsoft C++ Guidelines Support Library)
## Running
Though this is a library, there is a demo application. It starts the currently
running shell (or `/bin/bash` if `SHELL` environment variable is not set) and
runs it in a ncurses window.