diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 00000000..9a30ac01 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,10 @@ +This directory contains the following scripts. All of the other files in this folder are helper scripts and should not be run directly. + +# `api-update.sh` + +Use this script to copy any API documentation changes to the Jekyll webpage (gh-pages). + +# `generate-doc-index.sh` + +Generate a sorted list of functions/variables from the API documentation. The output can then be manually edited into the index section of `API.md`. + diff --git a/scripts/api-update.sh b/scripts/api-update.sh index 6e48bdac..c236bb4f 100755 --- a/scripts/api-update.sh +++ b/scripts/api-update.sh @@ -5,7 +5,12 @@ # Copyright (c) 2014-2016, Justin Ethier # All rights reserved. # -# Copy API documentation to the Jekyll webpage (gh-pages) +# Purpose +# Use this script to copy API documentation changes to the Jekyll webpage (gh-pages). +# +# Usage +# Run this script from the main directory of the repo: +# $ ./scripts/api-update.sh # TMP=/tmp/cyclone-docs