Permalink
Browse files

add copying, update Documentation, closes #2

  • Loading branch information...
makefu committed Dec 30, 2013
1 parent c1ed878 commit 023fd080fa296a3969e2b69a784ed34f3e5a1628
Showing with 48 additions and 2 deletions.
  1. +14 −0 COPYING
  2. +34 −2 README.md
View
14 COPYING
@@ -0,0 +1,14 @@
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ Version 2, December 2004
+
+ Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+ DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
+
View
@@ -1,10 +1,36 @@
-Customized OpenWRT image generator
+Minikrebs: A Customized OpenWRT image generator
==================================
-Based on http://shackspace.de/wiki/doku.php?id=project:minikrebs
+Original Documentation: http://shackspace.de/wiki/doku.php?id=project:minikrebs
+
+Contact
+------
+If you want to know more about the project and how to use it, go to
+irc://freenode.org to #krebs or contact @makefoo on twitter.
+
+
+Example Usage
+=======
+Build instacam webcam server
+------------------------
+
+ # grab repository
+ git clone https://github.com/krebscode/minikrebs && cd minikrebs
+ # get everything ready for instacam
+ # this may need some time run initially
+ ./prepare instacam
+ # PLATFORM=TLMR3020 ./prepare instacam # for a MR3020 based image
+
+ # build the image
+ builder/init
+ # flash the device, either copy the sysupgrade image (from output before)
+ # to the device or use the upgrade script (ssh must be available)
+ ./upgrade <ip-of-device>
+
Build image that contains a webradio client
-------------------------------------------
+Build A webradio client based on probonopd@github's code
# If you want to build for a device other than the TP-LINK TL-WR703N, do:
export PLATFORM=DIR505A1 # for D-Link DIR-505
@@ -30,3 +56,9 @@ If you have totally mis-configured the network and can't get in anymore, use "Op
### Setting up radio stations and remote control codes
* http://192.168.0.19/cgi-bin/luci/admin/radio/stations
* http://192.168.0.19/cgi-bin/luci/admin/radio/remote (this is for a 3.3V 16MHz Arduino to be hooked up to the router)
+
+
+LICENSE
+======
+All code written around the original OpenWRT Image generator
+(traits,libs,gluecode) is licensed under the WTFPL, see COPYING

0 comments on commit 023fd08

Please sign in to comment.