<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>README</title>
<style>
html {
line-height: 1.5;
font-family: Georgia, serif;
font-size: 20px;
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 1em;
}
}
@media print {
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
font-size: 85%;
margin: 0;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
background-color: #1a1a1a;
border: none;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<p><a href="https://github.com/dumrich/zui/actions/workflows/rust.yml"><img src="https://github.com/dumrich/zui/actions/workflows/rust.yml/badge.svg" alt="Rust" /></a> # zui A minimal terminal manipulation library written in Rust.</p>
<h2 id="what-is-it">What is it?</h2>
<p><code>zui</code> is a library that intends to make terminal interfaces, simple or complex, easy to create. It is heavily inspired by <a href="https://github.com/redox-os/termion">Termion</a> and <a href="https://github.com/fdehau/tui-rs">tui-rs</a></p>
<p>It’s goals are as follows:</p>
<ul class="task-list">
<li><input type="checkbox" disabled="" checked="" />
Zero external dependencies (aside from libc)</li>
<li><input type="checkbox" disabled="" checked="" />
Color Support</li>
<li><input type="checkbox" disabled="" checked="" />
Text Styling</li>
<li><input type="checkbox" disabled="" checked="" />
Low-level Terminal information</li>
<li><input type="checkbox" disabled="" checked="" />
Cursor Support</li>
<li><input type="checkbox" disabled="" checked="" />
Clear Terminal Support</li>
<li><input type="checkbox" disabled="" checked="" />
ANSI Raw Mode Support</li>
<li><input type="checkbox" disabled="" checked="" />
Keyboard Support & async stdin</li>
<li><input type="checkbox" disabled="" checked="" />
Multiple Screens</li>
<li><input type="checkbox" disabled="" checked="" />
Polish up existing interface and add docs (0.0.1 release)</li>
<li><input type="checkbox" disabled="" />
Mouse Support</li>
</ul>
<h2 id="what-isnt-it">What isn’t it?</h2>
<p>It’s goals are <strong>not</strong> as follows:</p>
<ul>
<li>Compile on non Unix machines</li>
</ul>
<h2 id="license">License</h2>
<p><a href="https://github.com/dumrich/zui/blob/master/LICENSE.md">GPL</a></p>
</body>
</html>