36 lines
2.1 KiB
Markdown
36 lines
2.1 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/vinibiavatti1/TuiCss">
|
|
<img src="https://raw.githubusercontent.com/vinibiavatti1/TuiCss/develop/resources/TUICSS%20Logo%20160x160%20transparent.png" />
|
|
</a>
|
|
</p>
|
|
|
|
<h3 align="center">TuiCss</h3>
|
|
|
|
<p align="center">
|
|
Text-based user interface CSS library
|
|
<br>
|
|
<a href="https://github.com/vinibiavatti1/TuiCss/wiki"><strong>-- Documentation --</strong></a>
|
|
<br><br>
|
|
<a href="https://badge.fury.io/js/tuicss">
|
|
<img src="https://badge.fury.io/js/tuicss.svg" alt="npm version badge">
|
|
</a>
|
|
</p>
|
|
|
|
### About
|
|
|
|
TuiCss is a library focused to create web applications using an interface based on ASCII table, like the old MS-DOS applications. This kind of interface is very eligible because the ultra-contrast colors used and because the reduced effects used on the components in the view. The base of this project is <a href="https://en.wikipedia.org/wiki/Turbo_Vision">Turbo Vision Framework</a>, but some other frameworks were checked also to introduce some features to TuiCss, like [curses](https://en.wikipedia.org/wiki/Curses_(programming_library)), [ncurses](https://en.wikipedia.org/wiki/Ncurses), [Newt](https://en.wikipedia.org/wiki/Newt_(programming_library)), etc. Check the examples page in the wiki to stay on top of some creations, or check the getting started page to start use this library!
|
|
|
|
<img src="https://raw.githubusercontent.com/vinibiavatti1/TuiCss/develop/resources/TUICSS%20Demo.png" width="676">
|
|
|
|
### Getting Started
|
|
To start to use the TuiCss in your project, you can just download the repository content and import the files that are in the dist folder with the html directives. On the other hand, you can install the package with NPM using the following command:
|
|
|
|
```bash
|
|
$ npm install tuicss
|
|
```
|
|
|
|
For more details, visit the [Getting Started Page](https://github.com/vinibiavatti1/TuiCss/wiki/Getting-Started) in the respoitory wiki.
|
|
|
|
### Documentation
|
|
Check the [repository wiki](https://github.com/vinibiavatti1/TuiCss/wiki) to access the documentation, components index, examples, styles, or to know how to contribute for this project.
|