mirror of
https://github.com/RGBCube/ZTerm
synced 2025-07-29 00:47:44 +00:00
60 lines
1.8 KiB
Markdown
60 lines
1.8 KiB
Markdown
# ZTerm
|
|
|
|
Terminal abstraction library for Zig.
|
|
|
|
## Contents
|
|
|
|
This is a simple guide to using the library.
|
|
The contents will be briefly covered here.
|
|
|
|
### Spinner
|
|
|
|
```zig
|
|
const std = @import("std");
|
|
const time = std.time;
|
|
const zterm = @import("zterm");
|
|
|
|
pub fn main() !void {
|
|
var sp = zterm.Spinner{
|
|
.charset = zterm.Spinner.charsets[3],
|
|
.message = "Selling all your data to the CCP...",
|
|
};
|
|
try sp.start();
|
|
|
|
time.sleep(3 * time.ns_per_s);
|
|
sp.setMessage("Calculating very important stuff while selling your data...");
|
|
|
|
time.sleep(2 * time.ns_per_s);
|
|
try sp.stop(.{
|
|
.charset = "✓",
|
|
.message = "Successfully sold all your data to the CCP! You data is not in safe hands!",
|
|
});
|
|
}
|
|
```
|
|
|
|
## License
|
|
|
|
```
|
|
MIT License
|
|
|
|
Copyright (c) 2023-present RGBCube
|
|
|
|
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.
|
|
|
|
```
|