Browse Source

Add note about frozen branch

Marcel Stör 7 years ago
parent
commit
1885a30bd9
2 changed files with 8 additions and 2 deletions
  1. 5 2
      README.md
  2. 3 0
      docs/index.md

+ 5 - 2
README.md

@@ -1,10 +1,13 @@
-# **NodeMCU 1.5.4.1** #
+# **NodeMCU 1.5.4.1 final** #
 
 [![Join the chat at https://gitter.im/nodemcu/nodemcu-firmware](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/nodemcu/nodemcu-firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://travis-ci.org/nodemcu/nodemcu-firmware.svg)](https://travis-ci.org/nodemcu/nodemcu-firmware)
-[![Documentation Status](https://img.shields.io/badge/docs-dev-yellow.svg?style=flat)](http://nodemcu.readthedocs.io/en/dev/)
+[![Documentation Status](https://img.shields.io/badge/docs-1.5.4.1_final-yellow.svg?style=flat)](http://nodemcu.readthedocs.io/en/1.5.4.1-final/)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/nodemcu/nodemcu-firmware/blob/master/LICENSE)
 
+## :no_entry: This branch is frozen at the last commit before the Espressif SDK was upgraded to 2.0 :no_entry:
+
+
 ### A Lua based firmware for ESP8266 WiFi SOC
 
 NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/). The firmware is based on the [Espressif NON-OS SDK 1.5.4.1](http://bbs.espressif.com/viewtopic.php?f=46&t=2376) and uses a file system based on [spiffs](https://github.com/pellepl/spiffs). The code repository consists of 98.1% C-code that glues the thin Lua veneer to the SDK.

+ 3 - 0
docs/index.md

@@ -1,5 +1,8 @@
 # NodeMCU Documentation
 
+!!! attention
+	This branch is frozen at the last commit before the Espressif SDK was upgraded to 2.0!
+
 NodeMCU is an [eLua](http://www.eluaproject.net/) based firmware for the [ESP8266 WiFi SOC from Espressif](http://espressif.com/en/products/esp8266/).  The NodeMCU *firmware* is a companion project to the popular [NodeMCU dev kits](https://github.com/nodemcu/nodemcu-devkit-v1.0), ready-made open source development boards with ESP8266-12E chips.
 
 ## Up-To-Date Documentation