Add basic documentation
This commit is contained in:
parent
309347a8ec
commit
811354b683
37
README.md
Normal file
37
README.md
Normal file
@ -0,0 +1,37 @@
|
||||
uh-wm
|
||||
=====
|
||||
|
||||
Xlib Window Manager prototype.
|
||||
|
||||
[![Version ][badge-version-img]][badge-version-uri]
|
||||
[![Build status ][badge-build-img]][badge-build-uri]
|
||||
[![Code Climate ][badge-cclimate-img]][badge-cclimate-uri]
|
||||
|
||||
|
||||
Getting started
|
||||
---------------
|
||||
|
||||
### Installation (requires ruby ~> 2.1 and rubygems)
|
||||
|
||||
```
|
||||
$ gem install uh-wm
|
||||
```
|
||||
|
||||
|
||||
### Usage
|
||||
|
||||
```
|
||||
Usage: uhwm [options]
|
||||
|
||||
options:
|
||||
-h, --help print this message
|
||||
```
|
||||
|
||||
|
||||
|
||||
[badge-version-img]: https://img.shields.io/gem/v/uh-wm.svg?style=flat-square
|
||||
[badge-version-uri]: https://rubygems.org/gems/uh-wm
|
||||
[badge-build-img]: https://img.shields.io/travis/tjouan/uh-wm/master.svg?style=flat-square
|
||||
[badge-build-uri]: https://travis-ci.org/tjouan/uh-wm
|
||||
[badge-cclimate-img]: https://img.shields.io/codeclimate/github/tjouan/uh-wm.svg?style=flat-square
|
||||
[badge-cclimate-uri]: https://codeclimate.com/github/tjouan/uh-wm
|
Loading…
x
Reference in New Issue
Block a user