Updated firewall documentation with ipset example; minor grammar fixes
[web.git] / index.txt
1 ---
2 ---
3 LEDE - Linux Embedded Development Environment
4 =============================================
5
6 == Welcome to the LEDE project
7
8 The LEDE project is a Linux based embedded meta distribution based on OpenWrt
9 and targeting a wide range of wireless SOHO routers and non-network devices.
10
11 LEDE spun away from the mother project in May 2016, aims for an open governance
12 model and attempts to simplify contributing to encourage new developers in
13 embedded development.
14
15 Refer to our link:about.html[about page] to learn more about the projects
16 origins.
17
18 === How can I use LEDE?
19
20 Since LEDE is a pretty young spinoff from OpenWrt it is largely compatible to
21 it, in most cases the same installation procedures can be used to flash your
22 devices.
23
24 Sysupgrades from OpenWrt to LEDE or vice versa are supported but it is advised
25 to not keep settings in such a case to benefit from the updated defaults.
26
27 === What is LEDE’s target audience?
28
29 As a source based Linux distribution for wireless routers, LEDE is primarily
30 intended for networking enthusiasts, wireless communities, embedded Linux
31 developers and advanced users.
32
33 LEDE aims for versatility and ease of customization but does not attempt to
34 be a fully integrated alternative to OEM firmware, it rather is a set of
35 building blocks to implement your own projects.
36
37 === How can I help?
38
39 Like any open source project, LEDE lives from the effort being put into it by
40 its users and developers. If you like to participate in development, please
41 refer to our link:development.html[development sub page] to learn more about
42 source code access and building instructions.
43
44 If you do not consider yourself a developer but want to participate in
45 maintaining documentation or in helping community members then don't hesitate
46 to join our https://lists.infradead.org/mailman/listinfo/lede-dev[mailing list]
47 or IRC channels to get in touch.
48
49 === Endorsement
50
51 The *Wrt community is made up of many great communities all tinkering on their
52 own mission in improving something on this planet. The Following communities have
53 kindly decided to endorse this project. Thanks !
54
55 - image:logo/endorsements/qmp.png[qMp logo] http://qmp.cat/News/31_qMp_endorses_the_LEDE_project["qMp endorses the LEDE project"]
56 - image:logo/endorsements/wirelesspt.png[WirelessPT logo] https://wirelesspt.net/wiki/LEDE["\"We wish huge success to the LEDE project\""]
57 - image:logo/endorsements/weimarnetz.png[Weimarnetz logo] https://weimarnetz.de/["Project Homepage"]
58 - image:logo/endorsements/bmx7.png[bmx.net logo] http://bmx6.net/news/24["\"We ... will consider it the new default OS environment for embedded devices running bmx6 and bmx7\""]
59 - image:logo/endorsements/libremesh.png[Libre-Mesh logo] http://libre-mesh.org/news.html#2016_08_06_endorsement_to_lede_project["\"We endorse the LEDE project and we plan to start basing Libre-Mesh releases on Linux Embedded Development Environment\""]