Skip to content

Commit ca24587

Browse files
authored
Merge pull request #1 from MCWertGaming/merge
small grammar fixes
2 parents bd73515 + 0c6cab2 commit ca24587

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,11 @@
99
[![pre-commit](https://github.com/jupyter-xeus/cpp-terminal/actions/workflows/pre-commit-check.yml/badge.svg)](https://github.com/jupyter-xeus/cpp-terminal/actions/workflows/pre-commit-check.yml)
1010
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jupyter-xeus/cpp-terminal/master.svg)](https://results.pre-commit.ci/latest/github/jupyter-xeus/cpp-terminal/maset)
1111

12-
`CPP-Terminal` is a small, simple and dependency-free library for writing platform independent terminal applications. It tries to follow the C++ 'Zero-overhead principle' and its header files only include std ones. It works on Windows, MacOS and
13-
Linux and offers a simple programming interface. It supports colors, keyboard input, terminal resizing and has all the basic features to write any terminal application. On windows the library automatically allocate a console on GUI application.
12+
`CPP-Terminal` is a small and dependency-free C++ library for writing platform independent terminal-based applications. It follows the "Zero-overhead principle" and limits externally included files to the C++ STL. Being crossplatform we are currently supporting Windows, Linux and MacOS and are providing an unified API across all plattforms. Our main features are consisting of Colors, Keyboard input, terminal resize handling, as well as other common terminal functionality. It's also possible to open a managed terminal from a windows GUI application.
1413

15-
## Minimal examples
14+
## Hello World example
1615

17-
The minimal Hello World is as simple as :
16+
To write a simple Hello World program, all you need to do is:
1817

1918
```cpp
2019
#include "cpp-terminal/io.hpp"
@@ -43,7 +42,7 @@ int main()
4342
}
4443
```
4544

46-
On windows, creating/attaching a console to a GUI application can be done easily :
45+
On wndows you can simply create or attach a console through a GUI application by doing:
4746

4847
```cpp
4948
#include "cpp-terminal/io.hpp"

tests/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ target_link_libraries(AttachConsole PRIVATE doctest::doctest cpp-terminal::cpp-t
3232
add_executable(AttachConsoleMinimal WIN32 attach_console_minimal.test.cpp)
3333
target_link_libraries(AttachConsoleMinimal PRIVATE doctest::doctest cpp-terminal::cpp-terminal)
3434

35+
add_executable(file.test file.test.cpp)
3536
target_link_libraries(file.test PRIVATE doctest::doctest cpp-terminal::cpp-terminal)
3637
doctest_discover_tests(file.test)
3738

0 commit comments

Comments
 (0)