From e9ef61f7ae4573b1ca7f77e3279bdbdb9f4c518c Mon Sep 17 00:00:00 2001 From: Christian Burger Date: Tue, 5 Apr 2022 10:24:22 +0200 Subject: [PATCH] added license and basic "read me" information --- .vscode/settings.json | 3 ++- LICENSE | 21 +++++++++++++++++++++ README.md | 21 +++++++++++++++++++++ 3 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 README.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 2847634..463cfb4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -52,6 +52,7 @@ "iomanip": "cpp", "iostream": "cpp", "stdexcept": "cpp", - "typeinfo": "cpp" + "typeinfo": "cpp", + "pointers": "cpp" } } \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cc1f711 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Christian Burger + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f4b3c5 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file