mirror of
https://github.com/openwrt/luci.git
synced 2026-04-15 19:01:56 +00:00
44fd0155ff
- style with clean-jsdoc-theme (supports dark mode) - add tutorials (jaguar has a problem with this structure) - move doc gen stubs to doc_gen folder This change moves the generated JS API docs from /luci/jsapi to /luci via README.md which forms the index, and shall point to a generated html file which exists. It currently points to LuCI.html, which depends on JSDoc naming conventions. So it's possible the link can break if modules change names. But the TOC is always valid. Signed-off-by: Paul Donald <newtwen+github@gmail.com>
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
# OpenWrt luci feed
|
|
|
|
[](https://hosted.weblate.org/engage/openwrt/?utm_source=widget)
|
|
|
|
## 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:
|
|
```sh
|
|
./scripts/feeds update luci
|
|
./scripts/feeds install -a -p luci
|
|
```
|
|
|
|
## API Reference
|
|
|
|
You can browse the generated API documentation directly on Github.
|
|
|
|
Use [ucode](https://ucode.mein.io/) and rpcd for server side operations.
|
|
|
|
- [Client side JavaScript APIs](http://openwrt.github.io/luci/jsapi/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.
|
|
|
|
## Translation status
|
|
|
|
Use [Weblate](https://hosted.weblate.org/engage/openwrt/?utm_source=widget) instead of direct editing of the `*.po` files.
|
|
|
|
[](https://hosted.weblate.org/engage/openwrt/?utm_source=widget)
|