|
2 | 2 |
|
3 | 3 | [](https://gitter.im/nodemcu/nodemcu-firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
4 | 4 | [](https://travis-ci.org/nodemcu/nodemcu-firmware)
|
5 |
| -[](http://nodemcu.readthedocs.io/en/latest/) |
| 5 | +[](http://nodemcu.readthedocs.io/en/master/) |
6 | 6 | [](https://github.com/nodemcu/nodemcu-firmware/blob/master/LICENSE)
|
7 | 7 |
|
8 | 8 | ### A Lua based firmware for ESP8266 WiFi SOC
|
@@ -45,31 +45,31 @@ wifi.sta.config("SSID", "password")
|
45 | 45 |
|
46 | 46 | The entire [NodeMCU documentation](https://nodemcu.readthedocs.io) is maintained right in this repository at [/docs](docs). The fact that the API documentation is mainted in the same repository as the code that *provides* the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at [https://nodemcu.readthedocs.io](https://nodemcu.readthedocs.io).
|
47 | 47 |
|
48 |
| -- How to [build the firmware](https://nodemcu.readthedocs.io/en/dev/en/build/) |
49 |
| -- How to [build the filesystem](https://nodemcu.readthedocs.io/en/dev/en/spiffs/) |
50 |
| -- How to [flash the firmware](https://nodemcu.readthedocs.io/en/dev/en/flash/) |
51 |
| -- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/dev/en/upload/) |
| 48 | +- How to [build the firmware](https://nodemcu.readthedocs.io/en/master/en/build/) |
| 49 | +- How to [build the filesystem](https://nodemcu.readthedocs.io/en/master/en/spiffs/) |
| 50 | +- How to [flash the firmware](https://nodemcu.readthedocs.io/en/master/en/flash/) |
| 51 | +- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/master/en/upload/) |
52 | 52 | - API documentation for every module
|
53 | 53 |
|
54 | 54 | # Releases
|
55 | 55 |
|
56 |
| -Due to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated [custom firmware build service](http://nodemcu-build.com/) to get the specific firmware configuration you need, or consult the [documentation](http://nodemcu.readthedocs.io/en/dev/en/build/) for other options to build your own firmware. |
| 56 | +Due to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated [custom firmware build service](http://nodemcu-build.com/) to get the specific firmware configuration you need, or consult the [documentation](http://nodemcu.readthedocs.io/en/master/en/build/) for other options to build your own firmware. |
57 | 57 |
|
58 | 58 | This project uses two main branches, `master` and `dev`. `dev` is actively worked on and it's also where PRs should be created against. `master` thus can be considered "stable" even though there are no automated regression tests. The goal is to merge back to `master` roughly every 2 months. Depending on the current "heat" (issues, PRs) we accept changes to `dev` for 5-6 weeks and then hold back for 2-3 weeks before the next snap is completed.
|
59 | 59 |
|
60 | 60 | A new tag is created every time `dev` is merged back to `master`. They are listed in the [releases section here on GitHub](https://github.com/nodemcu/nodemcu-firmware/releases). Tag names follow the \<SDK-version\>-master_yyyymmdd pattern.
|
61 | 61 |
|
62 | 62 | # Support
|
63 | 63 |
|
64 |
| -See [https://nodemcu.readthedocs.io/en/dev/en/support/](https://nodemcu.readthedocs.io/en/dev/en/support/). |
| 64 | +See [https://nodemcu.readthedocs.io/en/master/en/support/](https://nodemcu.readthedocs.io/en/master/en/support/). |
65 | 65 |
|
66 | 66 | # License
|
67 | 67 |
|
68 | 68 | [MIT](https://github.com/nodemcu/nodemcu-firmware/blob/master/LICENSE) © [zeroday](https://github.com/NodeMCU)/[nodemcu.com](http://nodemcu.com/index_en.html)
|
69 | 69 |
|
70 | 70 | # Build Options
|
71 | 71 |
|
72 |
| -The following sections explain some of the options you have if you want to [build your own NodeMCU firmware](http://nodemcu.readthedocs.io/en/dev/en/build/). |
| 72 | +The following sections explain some of the options you have if you want to [build your own NodeMCU firmware](http://nodemcu.readthedocs.io/en/master/en/build/). |
73 | 73 |
|
74 | 74 | ### Select Modules
|
75 | 75 |
|
|
0 commit comments