diff --git a/README.md b/README.md index bcfb807b..2ee330ec 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,34 @@ -![libYUI-boilerplate](http://img191.imageshack.us/img191/9364/libyui.png) +# LibYUI - The Ncurses (Text Mode) Frontend -[![Build Status](https://travis-ci.org/libyui/libyui-ncurses.svg?branch=master)](https://travis-ci.org/libyui/libyui-ncurses) +[![Build Status](https://travis-ci.org/libyui/libyui-ncurses.svg?branch=master +)](https://travis-ci.org/libyui/libyui-ncurses) -Libyui is a widget abstraction library providing Qt, GTK and ncurses -frontends. It was developed for [YaST](http://yast.github.io/). + +[Libyui](https://github.com/libyui/libyui) is a widget abstraction library +providing Qt, GTK and Ncurses frontends. Originally it was developed for +[YaST](https://yast.github.io/) but it can be used in any independent project. + +This part contains the text mode front end which displays the UI in a console +or a terminal emulator. ### Building Libyui uses CMake, driven by a slightly complex set of -[CMakefiles](https://github.com/libyui/libyui/tree/master/buildtools). +[CMakefiles](https://github.com/libyui/libyui/tree/master/buildtools). For +reproducible builds it is best to use the [libyui-rake]( +https://github.com/libyui/libyui-rake) Ruby gem like the [Jenkins CI]( +https://ci.opensuse.org/view/libyui/) jobs do. + +It can be installed from [rubygems.org](https://rubygems.org/gems/libyui-rake/) +using this command (Ruby needs to be installed in the system): -For reproducible builds it is best to use -[rubygem-packaging_rake_tasks.rpm](https://github.com/openSUSE/packaging_tasks) -like the [Jenkins CI](https://ci.opensuse.org/view/libyui/) jobs do. +``` +gem install libyui-rake +``` -You need [the base libyui library](https://github.com/libyui/libyui) -checked out in `../libyui` (or point the environment variable `LIBYUI_BASE` -to it). +Then to build the package run: -Then run: ``` -rake -f ../libyui/Rakefile osc:build +rake osc:build ``` +