working on doc
parent
ad95a16e89
commit
ee789c9105
16
readme.md
16
readme.md
|
@ -1,4 +1,4 @@
|
||||||
# uCOMmandIt Template Package Repository
|
# uCOMmandIt I2C Bus and Device Class Library
|
||||||
|
|
||||||
<!-- find and replace the package name to match -->
|
<!-- find and replace the package name to match -->
|
||||||
[![Build Status](https://img.shields.io/travis/uCOMmandIt/uci-pkg-template.svg?branch=master)](https://travis-ci.org/uCOMmandIt/uci-pkg-template)
|
[![Build Status](https://img.shields.io/travis/uCOMmandIt/uci-pkg-template.svg?branch=master)](https://travis-ci.org/uCOMmandIt/uci-pkg-template)
|
||||||
|
@ -6,17 +6,3 @@
|
||||||
[![Dependencies](https://img.shields.io/david/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template)
|
[![Dependencies](https://img.shields.io/david/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template)
|
||||||
[![devDependencies](https://img.shields.io/david/dev/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template?type=dev)
|
[![devDependencies](https://img.shields.io/david/dev/uCOMmandIt/uci-pkg-template.svg)](https://david-dm.org/uCOMmandIt/uci-pkg-template?type=dev)
|
||||||
[![codecov](https://img.shields.io/codecov/c/github/uCOMmandIt/uci-pkg-template/master.svg)](https://codecov.io/gh/uCOMmandIt/uci-pkg-template)
|
[![codecov](https://img.shields.io/codecov/c/github/uCOMmandIt/uci-pkg-template/master.svg)](https://codecov.io/gh/uCOMmandIt/uci-pkg-template)
|
||||||
|
|
||||||
Clone this to get a quick start on a new uci package. It has all the testing ready to go with Travis-CI and code coverage. All the readme badges are included as well
|
|
||||||
|
|
||||||
Clone it for as a starting place for your own package!
|
|
||||||
|
|
||||||
You'll need codecov and travis-ci accounts
|
|
||||||
|
|
||||||
##Steps
|
|
||||||
|
|
||||||
1. Clone repo
|
|
||||||
2. Edit package.json
|
|
||||||
3. Edit badge urls changing to your repo path
|
|
||||||
4. Run npm install
|
|
||||||
5. Open a github
|
|
||||||
|
|
Loading…
Reference in New Issue