diff --git a/README.md b/README.md index 51869e6..a76af0c 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ only currently tested on zsh ## Quick start `git clone https://github.com/PrincessPi3/esp-install-custom.git ~` `bash ~/reinstall-esp-idf.sh` +`source ~/.zshrc` +`get_idf` ## Features `build` idf.py build diff --git a/help.txt b/help.txt index 176fa9e..c80170a 100644 --- a/help.txt +++ b/help.txt @@ -1,27 +1,33 @@ Modes: default: reinstalls non-interactively with no delays, logouts, or reboots - bash cron-reinstall-esp-idf.sh + `bash cron-reinstall-esp-idf.sh` test: tests the script. very fast. minimal actions taken. no reinstall is done - bash cron-reinstall-esp-idf.sh test + `bash cron-reinstall-esp-idf.sh test` retool: reinstalls bins and export.sh, nothing else - bash cron-reinstall-esp-idf.sh retool + `bash cron-reinstall-esp-idf.sh retool` cron: runs noninteractively with forced user logout and automatic reboot, plus delays - bash cron-reinstall-esp-idf.sh cron + `bash cron-reinstall-esp-idf.sh cron` interactive: interactively installs/reinstalls esp-idf - bash cron-reinstall-esp-idf.sh interactive + `bash cron-reinstall-esp-idf.sh interactive` help: display this help text - bash cron-reinstall-esp-idf.sh help + `bash cron-reinstall-esp-idf.sh help` + + +Usage: + Once installed for the first time, restart your shell. + to activate esp-idf with the custom additions, run: + `get_idf` Features: @@ -43,11 +49,11 @@ Features: Helpful Stuff: cron: reinstall from master everyday at 8pm, logging out users with warn delays and rebooting after - crontab -e + `crontab -e` 0 8 * * * bash $HOME/esp/esp-install-custom/cron-reinstall-esp-idf.sh cron manually wipe logs: - rm $ESPIDF_INSTALLDIR/install.log; rm $ESPIDF_INSTALLDIR/version-data.txt; touch $ESPIDF_INSTALLDIR/install.log; touch $ESPIDF_INSTALLDIR/version-data.txt; + `rm $ESPIDF_INSTALLDIR/install.log; rm $ESPIDF_INSTALLDIR/version-data.txt; touch $ESPIDF_INSTALLDIR/install.log; touch $ESPIDF_INSTALLDIR/version-data.txt;` monitor log file during install: - tail -n 75 $ESPIDF_INSTALLDIR/install.log; \ No newline at end of file + `tail -n 75 $ESPIDF_INSTALLDIR/install.log;` \ No newline at end of file diff --git a/version.txt b/version.txt index c909c8d..7c92c2e 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -60-beta.3 \ No newline at end of file +60-beta.4 \ No newline at end of file