From 5411a40dfdb09cb26aeded3d685a0f42e18c4a05 Mon Sep 17 00:00:00 2001 From: Vinicius Reif Biavatti Date: Thu, 12 Sep 2019 13:20:49 -0300 Subject: [PATCH] Update README.md --- README.md | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 4de1be8..14e34ea 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,9 @@ # TuiCss ### Text-based user interface CSS framework -TuiCss is a framework focused to create web applications using an interface based in ASCII table, like MS-DOS applications. This kind of interface is very eligible because the ultra-contrast colors used and the less effects of the elements. The main framework thats is following to develop TuiCss is Turbo Vision Framework with some techniques with [box-drawing characters](https://en.wikipedia.org/wiki/Box-drawing_character), but some others frameworks were checked too, 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 see some creations! +TuiCss is a framework focused to create web applications using an interface based in ASCII table, like MS-DOS applications. This kind of interface is very eligible because the ultra-contrast colors used and the less effects of the elements. The main framework thats is following to develop TuiCss is Turbo Vision Framework with some techniques with [box-drawing characters](https://en.wikipedia.org/wiki/Box-drawing_character), but some others frameworks were checked too, 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 see some creations! ### 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. - -### Getting Started -TuiCss needs the JQuery to works with the script. To import JQuery, you can download or get this from CDN. This is the import code using Jquery from CDN: - -```html - -``` - -To use TuiCss framework in your web application, you need just to import the files in your html pages. The files are in dist folder. The folder has this structure: - -``` -dist - \- fonts - \- images - \- tuicss.css - \- tuicss.js - \- tuicss.min.css - \- tuicss.min.js -``` - -Get this folder and put in you application structure. After this, choose the file to import (source or minified). This is an example of import code: - -```html - - -``` +Check the [repository wiki](https://github.com/vinibiavatti1/TuiCss/wiki) to access the documentation, getting started, components index, examples, styles, or to know how to contribute for this project.