/esp82xx

Useful ESP8266 C Environment

Primary LanguageCOtherNOASSERTION

esp82xx

Useful ESP8266 C Environment. Intended to be included as sub-modules in derivate projects.

List of projects using esp82xx

Notes

  • Do not forget to use the --recursive option when cloning a porject with submodules like this

  • Cope with submodules updates:

    • Changes in the submodule:

      cd esp82xx

      Make changes

      git commit -m 'Your Message' git push

    • Then bump the version in the main project root folder:

      cd .. git submodule updates git add esp82xx git commit -m 'Bumped submodule version' git push

  • Outline to make a new project:

     git init project_name
 cd project_name
 git submodule add git@github.com:cnlohr/esp82xx.git
 cp esp28xx/user.cfg.example user.cfg
 cp esp28xx/Makefile.example Makefile
 mkdir -p web/page
 mkdir user
 ln -s esp28xx/web/Makefile web/

    Then link, edit and copy to your heart's content. See esp82XX-basic for a minimal example.

  • You should not include binaries in the project repository itself. There is a make target that builds the binaries and creates a .tar file that can be included with the release. To make a release, just tag a commit with git tag -a 'v1.3.3.7' -m 'Your release caption' and push the tag with git push --tags.

    After that, the github web-interface will allow you to make a release out of the new tag and include the binary file. To make the zip file invoke make projectname-version-binaries.tgz (Tab-autocomplete is your friend).