Skip to content
This repository was archived by the owner on Jan 29, 2023. It is now read-only.

Commit c84595f

Browse files
authored
Update README.md
1 parent f77ca0b commit c84595f

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,21 @@ Functions using normal software timers, relying on loop() and calling millis(),
2020

2121
The catch is your function is now part of an ISR (Interrupt Service Routine), and must be lean / mean, and follow certain rules. More to read on:
2222

23-
https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/
23+
[Attach Interrupt](https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/)
2424

2525
**Important Notes:**
2626
1. Inside the attached function, delay() won’t work and the value returned by millis() will not increment. Serial data received while in the function may be lost. You should declare as volatile any variables that you modify within the attached function.
2727

2828
2. Typically global variables are used to pass data between an ISR and the main program. To make sure variables shared between an ISR and the main program are updated correctly, declare them as volatile.
2929

30-
## Installation
31-
1. Navigate to (https://github.com/khoih-prog/ESP8266TimerInterrupt) page.
30+
### Installation
31+
32+
#### Use Arduino Library Manager
33+
34+
The suggested and easiest way is to use `Arduino Library Manager`. Search for `ESP8266TimerInterrupt`, then select / install the latest version.
35+
36+
#### Manual Install
37+
1. Navigate to [ESP8266TimerInterrupt](https://github.com/khoih-prog/ESP8266TimerInterrupt).
3238
2. Download the latest release `ESP8266TimerInterrupt-master.zip`.
3339
3. Extract the zip file to `ESP8266TimerInterrupt-master` directory
3440
4. Copy whole folder to Arduino libraries' directory such as `.Arduino/libraries/ESP8266TimerInterrupt-master`.
@@ -127,8 +133,6 @@ void loop()
127133
## TO DO
128134

129135
1. Search for bug and improvement.
130-
2. Similar features for Arduino (UNO, Mega, etc...) and ESP32
131-
132136

133137
## DONE
134138

@@ -138,6 +142,7 @@ For current version v1.0.2
138142
2. Fix compatibility issue causing compiler error while using Arduino IDEs before 1.8.10 and ESP8266 cores 2.5.2 and before
139143
3. More hardware-initiated software-enabled timers
140144
4. Longer time interval
145+
5. Similar features for Arduino (UNO, Mega, etc...) and ESP32
141146

142147

143148
## Contributing

0 commit comments

Comments
 (0)