Merge pull request #753 from platschi/master
[project/luci.git] / README.md
1 # OpenWrt luci feed
2
3 ## Description
4
5 This is the OpenWrt "luci"-feed containing LuCI - OpenWrt Configuration Interface.
6
7 ## Usage
8
9 This feed is enabled by default. Your feeds.conf.default (or feeds.conf) should contain a line like:
10 ```
11 src-git luci https://github.com/openwrt/luci.git
12 ```
13
14 To install all its package definitions, run:
15 ```
16 ./scripts/feeds update luci
17 ./scripts/feeds install -a -p luci
18 ```
19
20 ## API Reference
21
22 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).
23
24 ## License
25
26 See [LICENSE](LICENSE) file.
27  
28 ## Package Guidelines
29
30 See [CONTRIBUTING.md](CONTRIBUTING.md) file.