Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lslezak committed Feb 16, 2017
1 parent 04f630e commit a44521c
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions 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
```

0 comments on commit a44521c

Please sign in to comment.