Skip to content

Commit

Permalink
Small changes to the Readme.md. (#1429)
Browse files Browse the repository at this point in the history
  • Loading branch information
slaff authored Aug 10, 2018
1 parent c7febf6 commit e02467c
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ Sming - Open Source framework for high efficiency WiFi SoC ESP8266 native develo
[![Download](https://img.shields.io/badge/download-~1.7M-orange.svg)](https://github.com/SmingHub/Sming/releases/latest)
[![Build](https://travis-ci.org/SmingHub/Sming.svg?branch=develop)](https://travis-ci.org/SmingHub/Sming)

If you like **Sming**, give it a star, or fork it and [contribute](#contribute)!

[![GitHub stars](https://img.shields.io/github/stars/SmingHub/Sming.svg?style=social&label=Star)](https://github.com/SmingHub/Sming/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/SmingHub/Sming.svg?style=social&label=Fork)](https://github.com/SmingHub/Sming/network)

## Summary
* Highly effective in performance and memory usage (this is native firmware!)
* Simple and powerful hardware API wrappers
Expand All @@ -34,7 +39,7 @@ Sming - Open Source framework for high efficiency WiFi SoC ESP8266 native develo
OS/SDK | Linux | Mac OS X | Windows | FreeBSD-current |
-------|-------|----------|---------|-----------------|
UDK (v1.5) | n/a | n/a | [![Build status](https://ci.appveyor.com/api/projects/status/5aj0oi0wyk4uij00/branch/develop?svg=true)](https://ci.appveyor.com/project/slaff/sming-sb483/branch/develop) | n/a |
esp-open-sdk (v1.4, v1.5, v2.0) | :sunny: | :sunny: | n/a | n/a |
esp-open-sdk (v1.4, v1.5, v2.0) | :sunny: | :sunny: | n/a | :sunny: |

OS = Operating System.
SDK = Software Development Kit.
Expand Down Expand Up @@ -204,7 +209,7 @@ void OtaUpdate()

For a complete example take a look at the [Basic_rBoot](samples/Basic_rBoot/app/application.cpp) sample.

### Embedded HTTP WebServer
### Embedded HTTP Web Server
```c++
server.listen(80);
server.addPath("/", onIndex);
Expand Down Expand Up @@ -288,16 +293,24 @@ make docs

The newly generated documentation will be located under Sming/docs/api.

## Financial contributions

## Contribute

You can contribute to Sming by
- Providing Pull Requests with new features, bug fixes, new ideas, etc.
Make sure to follow our [Coding-Style-Rules](https://github.com/SmingHub/Sming/wiki/Coding-Style-Rules). Read our [Contributing guide](https://github.com/SmingHub/Sming/blob/develop/CONTRIBUTING.md) for details.
- Testing our latest source code and reporting issues.
- Supporting us financially to acquire hardware for testing and implementing or out of gratitude

### Financial contributions

We welcome financial contributions in full transparency on our [open collective](https://opencollective.com/Sming) page.
They help us improve the project and the community around it. If you would like to support us you can [become a backer](https://opencollective.com/Sming#backer) or [a sponsor](https://opencollective.com/Sming#sponsor).

In addition to that anyone who is helping this project can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.



### Contributors
#### Backers and sponsors

Thank you to all the people who have backed Sming
<a href="https://opencollective.com/Sming#backers" target="_blank"><img src="https://opencollective.com/Sming/backers.svg?width=890"></a>
Expand All @@ -306,4 +319,3 @@ or sponsored it.

<a href="https://opencollective.com/Sming/sponsor/0/website" target="_blank"><img src="https://opencollective.com/Sming/sponsor/0/avatar.svg"></a>


0 comments on commit e02467c

Please sign in to comment.