Skip to content

Commit 20c5ba2

Browse files
committed
Documentation: Increase heading sizes for readability
1 parent 7dd934c commit 20c5ba2

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Bash script for continuous integration of [Arduino](http://www.arduino.cc/) proj
55

66
[![Build Status](https://travis-ci.org/per1234/arduino-ci-script.svg?branch=master)](https://travis-ci.org/per1234/arduino-ci-script)
77

8-
#### Installation
8+
### Installation
99
The script can be used in multiple ways:
1010

11-
##### Clone the latest release
11+
#### Clone the latest release
1212
Include the latest release of the script in your project by adding the following lines to your build configuration file:
1313
```yaml
1414
# Clone the script repository
@@ -21,7 +21,7 @@ Include the latest release of the script in your project by adding the following
2121
- source "${HOME}/scripts/arduino-ci-script.sh"
2222
```
2323
24-
##### Local copy
24+
#### Local copy
2525
If you're passing a token to the script's publish report functions then best security practices would be to use a static copy of the script so you can be sure of the commands the token is used with:
2626
- Download the latest version of the script from https://github.com/per1234/arduino-ci-script/releases by clicking one of the **Source code** links.
2727
- Unzip the downloaded file.
@@ -33,10 +33,11 @@ If you're passing a token to the script's publish report functions then best sec
3333
Be sure to check for new releases of the script so that you can benefit from the ongoing development work. You can receive notifications of releases by [watching the repository](https://github.com/per1234/arduino-ci-script/subscription).
3434
3535
36-
#### Usage
36+
### Usage
3737
See https://github.com/per1234/WatchdogLog/blob/master/.travis.yml for an example of the script in use.
3838
3939
Please configure your continuous integration system to make the minimum number of downloads and sketch verifications necessary to effectively test your code. This will prevent wasting Arduino and Travis CI's bandwidth and keep the build durations short.
40+
4041
##### `set_script_verbosity SCRIPT_VERBOSITY_LEVEL`
4142
Control the level of verbosity of the script's output in the Travis CI log. Verbose output can be helpful for debugging but in normal usage it makes the log hard to read and may cause the log to exceed Travis CI's maximum log size of 4 MB, which causes the job to be terminated. The default verbosity level is `0`.
4243
- Parameter: **SCRIPT_VERBOSITY_LEVEL** - `0`, `1` or `2` (least to most verbosity).
@@ -185,11 +186,12 @@ Add the report to the report gist. See the [instructions for publishing job repo
185186
- Parameter: **doLinkComment** - `true` or `false` Whether to comment on the GitHub thread of the commit that triggered the build with a link to the report.
186187

187188

188-
#### Publishing job reports
189+
### Publishing job reports
189190
The script offers the option of publishing the job result reports to a repository or GitHub [gist](https://gist.github.com/) by using the `publish_report_to_repository` or `publish_report_to_gist` functions. This makes it easier to view the reports or to import them into a spreadsheet program. You also have the option of having the link to the reports automatically added in a comment to the commit that triggered the build. This requires some configuration, which is described in the instructions below.
190191

191192
NOTE: For security reasons, reports for builds of pull requests from a fork of the repository can not be published. If the owner of that fork wants to publish reports they can create a GitHub token (and gist if using `publish_report_to_gist`) and configure the Travis CI settings for their fork of the repository following these instructions.
192-
##### Creating a GitHub personal access token
193+
194+
#### Creating a GitHub personal access token
193195
This is required for either publishing option.
194196
1. Sign in to your GitHub account.
195197
2. Click your avatar at the top right corner of GitHub > **Settings** > **Developer settings** > **Personal access tokens** > **Generate new token**.
@@ -203,7 +205,8 @@ This is required for either publishing option.
203205
9. Click the **Add** button.
204206

205207
An alternative to using a Travis CI hidden environment variable as described above is to define the GitHub personal access token as an encrypted environment variable: https://docs.travis-ci.com/user/environment-variables/#Encrypting-environment-variables.
206-
##### Creating a gist
208+
209+
#### Creating a gist
207210
This is required for use of the `publish_report_to_gist` function.
208211
1. Open https://gist.github.com/
209212
2. Sign in to your GitHub account.
@@ -216,9 +219,10 @@ This is required for use of the `publish_report_to_gist` function.
216219
9. Click the **Add** button.
217220

218221

219-
#### Troubleshooting
222+
### Troubleshooting
220223
##### Script hangs after an arduino command
221224
The Arduino IDE will usually try to start the GUI whenever there is an error in the command. Since the Travis CI build environment does not support this it will just hang for ten minutes until Travis CI automatically cancels the job. This means you get no useful information on the cause of the problem.
225+
222226
##### Verbose output
223227
Verbose output results in a harder to read log so you should leave it off or minimized when possible but it can be useful for troubleshooting. Note that turning on verbose output for a large build may cause the log to exceed 4 MB, which causes Travis CI to terminate the job.
224228
- Verbose script output - See [`set_script_verbosity` documentation](set_script_verbosity-script_verbosity_level) in the Usage section.
@@ -228,6 +232,7 @@ Verbose output results in a harder to read log so you should leave it off or min
228232
- `- set -o verbose`
229233
- Print a trace of simple commands, for commands, case commands, select commands, and arithmetic for commands and their arguments or associated word lists after they are expanded and before they are executed. The value of the PS4 variable is expanded and the resultant value is printed before the command and its expanded arguments.
230234
- `- set -o xtrace`
235+
231236
##### Problematic IDE versions
232237
Some older versions of the Arduino IDE have bugs or limitations that may cause problems if used with this script:
233238
- 1.5.1 and older - The command line interface was added in 1.5.2, thus no version older than that can be used.
@@ -239,5 +244,5 @@ Some older versions of the Arduino IDE have bugs or limitations that may cause p
239244
- 1.6.3 and older - Do not support installing boards (`--install-boards`), thus `install_package` can't be used if no newer IDE version has been installed.
240245

241246

242-
#### Contributing
247+
### Contributing
243248
Pull requests or issue reports are welcome! Please see the [contribution rules](https://github.com/per1234/arduino-ci-script/blob/master/CONTRIBUTING.md) for instructions.

0 commit comments

Comments
 (0)