Skip to content

Commit

Permalink
update readme (agauniyal#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
agauniyal authored Sep 3, 2016
1 parent 5bcaa40 commit 31a71f9
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
# rang (रंग)
[![Build Status](https://travis-ci.org/agauniyal/rang.svg?branch=master)](https://travis-ci.org/agauniyal/rang)
[![Coverage Status](https://coveralls.io/repos/github/agauniyal/rang/badge.svg?branch=master)](https://coveralls.io/github/agauniyal/rang?branch=master)
# rang [![Build Status](https://travis-ci.org/agauniyal/rang.svg?branch=master)](https://travis-ci.org/agauniyal/rang) [![Coverage Status](https://coveralls.io/repos/github/agauniyal/rang/badge.svg?branch=master)](https://coveralls.io/github/agauniyal/rang?branch=master)

colors for your terminal
#####Colors for your Terminal.

![rang-demo](https://cloud.githubusercontent.com/assets/7630575/13501282/0bd00074-e18c-11e5-9848-5bd1f20566d9.gif)

###How to use it
1. You just need *`rang.hpp`* from include directory, use it as `#include "rang.hpp"`
------
##How to use it
#### No build system/package manager
1. You just need [rang.hpp](https://raw.githubusercontent.com/agauniyal/rang/master/include/rang.hpp) from include directory, use it as `#include "rang.hpp"`
2. Check out the [wiki](https://github.com/agauniyal/rang/wiki) ~~& maybe glance inside ***`test`*** directory to see some usage~~
3. ???
4. Profit!!

###TODO
- [ ] get 100% coverage
#### Using Meson build system
- Make a `rang.wrap` file inside your `subprojects/` directory with following content -
```
[rang-git]
directory=rang
url=https://github.com/agauniyal/rang.git
revision=head
```
- Place this code inside your primary `meson.build` - `rang_dep = dependency('rang', fallback : ['rang', 'rang_dep'])`
- Make sure to include `rang_dep` as dependency wherever you need it.

------
##TODO
- [ ] support Windows versions < 10

0 comments on commit 31a71f9

Please sign in to comment.