Skip to content

Commit

Permalink
Updated readme with doc badge
Browse files Browse the repository at this point in the history
  • Loading branch information
FedeDP committed Mar 10, 2018
1 parent 0c1ca8a commit 5210997
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Build Status](https://travis-ci.org/FedeDP/libmodule.svg?branch=master)](https://travis-ci.org/FedeDP/libmodule)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3526dd92b6d84370b072bfadfc7da632)](https://www.codacy.com/app/FedeDP/libmodule?utm_source=github.com&utm_medium=referral&utm_content=FedeDP/libmodule&utm_campaign=Badge_Grade)
[![Documentation Status](https://readthedocs.org/projects/libmodule/badge/?version=latest)](http://libmodule.readthedocs.io/en/latest/?badge=latest)

Libmodule aims at let developers easily create modular C projects in a way that is both simple and elegant.
You will write less code, focusing on what you really need.
Expand All @@ -23,10 +24,11 @@ It is tested with both gcc and clang through [travis](https://travis-ci.org/Fede

## Is there any documentation?

Right now no. I'm sorry.
I'm focusing about providing as much features as possible, and the project is under heavy development.
Yes, it is availabe at http://libmodule.readthedocs.io/en/latest/.
Please note that I'm currently focusing about providing as much features as possible and the project is under heavy development,
so documentation can be out of date.
I promise that as soon as it is stable enough, documentation will be top priority (and provided asap).
For now you have to rely on my [samples](https://github.com/FedeDP/libmodule/tree/master/Samples).
You have some nice examples too, check [samples](https://github.com/FedeDP/libmodule/tree/master/Samples) folder.

## Build dep and how to build

Expand Down
3 changes: 1 addition & 2 deletions Samples/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# Libmodule Samples

This folder contains some libmodule's examples.
For now, they are the only API documentation available too.
As you can see, API is quite straightforward though, as being clean and simple has been one of the library's focus.
As you can see, API is quite straightforward as being clean and simple has been one of the library's focus.

To build these samples, use

Expand Down

0 comments on commit 5210997

Please sign in to comment.