Revamped README

This commit is contained in:
Rafi Khan
2015-03-07 17:22:29 -06:00
parent 77938e93c4
commit 51534b383f
2 changed files with 21 additions and 14 deletions

21
README.md Normal file
View File

@@ -0,0 +1,21 @@
# IRremote Arduino Library
This library enables you to send and receive using infra red signals on an arduino
## Version - 1.00
This is the master branch and includes the most stable version. For the latest-mostly stable version please try teh beta branch.
## Installation
1. Click "Download ZIP"
2. Extract the downloaded zip file
3. Rename the extracted folder from "Arduino-IRremote" to "IRremote"
4. Move this folder to your libraries directory
## Contributing
If you want to contribute to this project:
- Report bugs and errors
- Ask for enhancements
- Create issues and pull requests
- Tell other people about this library
## Copyright
Copyright 2009-2012 Ken Shirriff

14
readme
View File

@@ -1,14 +0,0 @@
This is the IRremote library for the Arduino.
To download from github (http://github.com/shirriff/Arduino-IRremote), click on the "Downloads" link in the upper right, click "Download as zip", and get a zip file. Unzip it and rename the directory shirriff-Arduino-IRremote-nnn to IRremote
To install, move the downloaded IRremote directory to:
arduino-1.x/libraries/IRremote
where arduino-1.x is your Arduino installation directory
After installation you should have files such as:
arduino-1.x/libraries/IRremote/IRremote.cpp
For details on the library see the Wiki on github or the blog post http://arcfn.com/2009/08/multi-protocol-infrared-remote-library.html
Copyright 2009-2012 Ken Shirriff