Add luci, based upon commit : ae8ddb0ca6dfe98cb842fe2c01b36c4df55a0894

[librecmc/librecmc.git] / package / luci / README.md

diff --git a/package/luci/README.md b/package/luci/README.md
new file mode 100644 (file)
index 0000000..48863a4
--- /dev/null
+++ b/package/luci/README.md
@@ -0,0 +1,34 @@
+# OpenWrt luci feed
+
+## Description
+
+This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.
+
+## Usage
+
+This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:
+```
+src-git luci https://github.com/openwrt/luci.git
+```
+
+To install all its package definitions, run:
+```
+./scripts/feeds update luci
+./scripts/feeds install -a -p luci
+```
+
+## API Reference
+
+You can browse the generated API documentation [directly on Github](http://htmlpreview.github.io/?http://raw.githubusercontent.com/openwrt/luci/master/documentation/api/index.html).
+
+## Development
+
+Documentation for developing and extending LuCI can be found [in the Wiki](https://github.com/openwrt/luci/wiki)
+
+## License
+
+See [LICENSE](LICENSE) file.
+ 
+## Package Guidelines
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) file.