Skip to content

Commit 3a3b580

Browse files
committed
Add cpp-terminal docs
1 parent 8e92d42 commit 3a3b580

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,20 +94,39 @@ We have created serval examples to show possible use cases of CPP-Terminal and t
9494
| Linux | All supported | x86_64 | 4.7<=GCC<= 12 3.5<=Clang<=15 intel-oneapi | 11,14,17,20 |
9595
| Linux (dockcross) | All supported | arm64 armv5 armv5-musl armv5-uclibc armv6 armv7a, mips, mipsel-lts, s390x, ppc64le, xtensa-uclibc, x86, x64, x64-clang, x64-tinycc | 4.7<=GCC<= 12 3.5<=Clang<=15 | 11,14,17,20 |
9696
97-
> Windows versions prior Windows 10 are missing the Win32 API functionality for entering the "raw mode" and therefore won't work. They are also lacking ANSI support. See #173 for adding support to prior windows versions for MSVC / Win32.
97+
> Windows versions prior Windows 10 are missing the Win32 API functionality for entering the "raw mode" and therefore
98+
> won't work. They are also lacking ANSI support. See #173 for adding support to prior windows versions for MSVC / Win32.
9899
99100
## How to use
100101
101-
Adding CPP-Terminal to your own project is really easy. We have collected various ways with easy how-to's [in our documentation](https://github.com/jupyter-xeus/cpp-terminal/wiki/Adding-CPP-Terminal-to-your-ptoject).
102+
Adding CPP-Terminal to your own project is really easy. We have collected various ways with easy
103+
how-to's [in our documentation](https://github.com/jupyter-xeus/cpp-terminal/wiki/Adding-CPP-Terminal-to-your-ptoject).
102104
103-
## Documentation
105+
## Documentation [![docs](https://github.com/jupyter-xeus/cpp-terminal/actions/workflows/docs.yml/badge.svg)](https://github.com/jupyter-xeus/cpp-terminal/actions/workflows/docs.yml) ##
104106
105-
CPP-Terminal's documentation can be found [here](https://github.com/jupyter-xeus/cpp-terminal/wiki).
107+
<h1 align="center">
108+
<a href="https://jupyter-xeus.github.io/cpp-terminal/">
109+
110+
```markdown
111+
🌍 Online
112+
```
113+
114+
</a>
115+
<a href="https://jupyter-xeus.github.io/cpp-terminal/cpp-terminal_Manual.pdf">
116+
117+
```markdown
118+
📖 PDF
119+
```
120+
121+
</a>
122+
</h1>
106123

107124
## Contributing
108125

109-
Contributing to CPP-Terminal is highly appreciated and can be done in more ways than code. Extending it's functionality, reporting or fixing bugs and extending the documentations are just a few of them.
126+
Contributing to CPP-Terminal is highly appreciated and can be done in more ways than code. Extending it's functionality,
127+
reporting or fixing bugs and extending the documentations are just a few of them.
110128

111129
## License
112130

113-
CPP-Terminal is licensed under the terms of [the MIT License](https://github.com/jupyter-xeus/cpp-terminal/blob/master/LICENSE) by Ondřej Čertík.
131+
CPP-Terminal is licensed under the terms
132+
of [the MIT License](https://github.com/jupyter-xeus/cpp-terminal/blob/master/LICENSE) by Ondřej Čertík.

0 commit comments

Comments
 (0)