feat(example): Restructure examples folder

examples/get-started/project_template/Makefile

@@ -0,0 +1,9 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := project_template
+
+include $(IDF_PATH)/make/project.mk
+

examples/get-started/project_template/components/component.mk

@@ -0,0 +1 @@
+COMPONENT_SRCDIRS := folder1 folder2

examples/get-started/project_template/main/component.mk

@@ -0,0 +1,5 @@
+#
+# "main" pseudo-component makefile.
+#
+# (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
+

examples/get-started/project_template/main/user_main.c

@@ -0,0 +1,85 @@
+/*
+ * ESPRSSIF MIT License
+ *
+ * Copyright (c) 2015 <ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD>
+ *
+ * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,
+ * it is free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ */
+
+#include "esp_common.h"
+
+/******************************************************************************
+ * FunctionName : user_rf_cal_sector_set
+ * Description  : SDK just reversed 4 sectors, used for rf init data and paramters.
+ *                We add this function to force users to set rf cal sector, since
+ *                we don't know which sector is free in user's application.
+ *                sector map for last several sectors : ABCCC
+ *                A : rf cal
+ *                B : rf init data
+ *                C : sdk parameters
+ * Parameters   : none
+ * Returns      : rf cal sector
+*******************************************************************************/
+uint32 user_rf_cal_sector_set(void)
+{
+    flash_size_map size_map = system_get_flash_size_map();
+    uint32 rf_cal_sec = 0;
+
+    switch (size_map) {
+        case FLASH_SIZE_4M_MAP_256_256:
+            rf_cal_sec = 128 - 5;
+            break;
+
+        case FLASH_SIZE_8M_MAP_512_512:
+            rf_cal_sec = 256 - 5;
+            break;
+
+        case FLASH_SIZE_16M_MAP_512_512:
+        case FLASH_SIZE_16M_MAP_1024_1024:
+            rf_cal_sec = 512 - 5;
+            break;
+
+        case FLASH_SIZE_32M_MAP_512_512:
+        case FLASH_SIZE_32M_MAP_1024_1024:
+            rf_cal_sec = 1024 - 5;
+            break;
+        case FLASH_SIZE_64M_MAP_1024_1024:
+            rf_cal_sec = 2048 - 5;
+            break;
+        case FLASH_SIZE_128M_MAP_1024_1024:
+            rf_cal_sec = 4096 - 5;
+            break;
+        default:
+            rf_cal_sec = 0;
+            break;
+    }
+
+    return rf_cal_sec;
+}
+/******************************************************************************
+ * FunctionName : user_init
+ * Description  : entry of user application, init user function here
+ * Parameters   : none
+ * Returns      : none
+*******************************************************************************/
+void user_init(void)
+{
+    printf("SDK version:%s\n", system_get_sdk_version());
+}
+

examples/get-started/project_template/readme.txt

@@ -0,0 +1,56 @@
+This is a simple project template.
+
+sample_lib is an example for multi-level folder Makefile, notice the folder structure and each Makefile, you can get the clue.
+
+
+HOWTO:
+1. Copy this folder to anywhere.
+Example:
+   Copy to ~/workspace/project_template
+   You can rename this folder as you like.
+
+2. Export SDK_PATH and BIN_PATH.
+Example:
+   Your SDK path is ~/esp_iot_rtos_sdk, and want generate bin at ~/esp8266_bin.
+   Do follow steps:
+     1>. export SDK_PATH=~/esp_iot_rtos_sdk
+     2>. export BIN_PATH=~/esp8266_bin
+   SDK and project are seperate, you can update SDK without change your project.
+
+3. Enter project_template folder, run ./gen_misc.sh, and follow the tips and steps.
+
+
+Compile Options:
+(1) COMPILE
+    Possible value: xcc
+    Default value:
+    If not set, use gcc by default.
+
+(2) BOOT
+    Possible value: none/old/new
+      none: no need boot
+      old: use boot_v1.1
+      new: use boot_v1.2
+    Default value: new
+
+(3) APP
+    Possible value: 0/1/2
+      0: original mode, generate eagle.app.v6.flash.bin and eagle.app.v6.irom0text.bin
+      1: generate user1
+      2: generate user2
+    Default value: 0
+
+(3) SPI_SPEED
+    Possible value: 20/26.7/40/80
+    Default value: 40
+
+(4) SPI_MODE
+    Possible value: QIO/QOUT/DIO/DOUT
+    Default value: QIO
+
+(4) SPI_SIZE_MAP
+    Possible value: 0/2/3/4/5/6
+    Default value: 0
+
+For example:
+    make COMPILE=gcc BOOT=new APP=1 SPI_SPEED=40 SPI_MODE=QIO SPI_SIZE_MAP=0