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

Commit 9caada0

Browse files
authored
v1.0.2
#### Release v1.0.2 1. Add [STM32_LAN8720 examples](./STM32_LAN8720)
1 parent bf9eb90 commit 9caada0

File tree

6 files changed

+111
-2
lines changed

6 files changed

+111
-2
lines changed

CONTRIBUTING.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Contributing to ESP_WiFiManager
2+
3+
### Reporting Bugs
4+
5+
Please report bugs in ESP_WiFiManager if you find them.
6+
7+
However, before reporting a bug please check through the following:
8+
9+
* [Existing Open Issues](https://github.com/khoih-prog/ESP_WiFiManager/issues) - someone might have already encountered this.
10+
11+
If you don't find anything, please [open a new issue](https://github.com/khoih-prog/ESP_WiFiManager/issues/new).
12+
13+
### How to submit a bug report
14+
15+
Please ensure to specify the following:
16+
17+
* Arduino IDE version (e.g. 1.8.11) or Platform.io version
18+
* `ESP8266` or `ESP32` Core Version (e.g. ESP8266 core v2.6.3 or ESP32 v1.0.4)
19+
* Contextual information (e.g. what you were trying to achieve)
20+
* Simplest possible steps to reproduce
21+
* Anything that might be relevant in your opinion, such as:
22+
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
23+
* Network configuration
24+
25+
26+
### Example
27+
28+
```
29+
Arduino IDE version: 1.8.11
30+
ESP8266 Core Version 2.6.3
31+
OS: Ubuntu 16.04 LTS
32+
Linux Inspiron 4.4.0-170-generic #199-Ubuntu SMP Thu Nov 14 01:45:04 UTC 2019 x86_64 x86_64 x86_64 GNU/Linux
33+
34+
Context:
35+
I encountered an endless loop while trying to connect to Local WiFi.
36+
37+
Steps to reproduce:
38+
1. ...
39+
2. ...
40+
3. ...
41+
4. ...
42+
```
43+
### Sending Feature Requests
44+
45+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
46+
47+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP_WiFiManager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
48+
49+
### Sending Pull Requests
50+
51+
Pull Requests with changes and fixes are also welcome!

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,34 @@ Sample codes:
9191

9292
The corresponding codes using Software Timers are also included to help understand the steps taken in order to convert those codes to be ISR-based.
9393

94+
95+
---
96+
---
97+
98+
## Installation
99+
100+
### Use Arduino Library Manager
101+
102+
The best and easiest way is to use `Arduino Library Manager`. Search for [**SmallProjects**](https://github.com/khoih-prog/SmallProjects), then select / install the latest version.
103+
You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/badge/SmallProjects.svg?)](https://www.ardu-badge.com/SmallProjects) for more detailed instructions.
104+
105+
### Manual Install
106+
107+
Another way to install is to:
108+
109+
1. Navigate to [**SmallProjects**](https://github.com/khoih-prog/SmallProjects) page.
110+
2. Download the latest release `SmallProjects-master.zip`.
111+
3. Extract the zip file to `SmallProjects-master` directory
112+
4. Copy whole `SmallProjects-master` folder to Arduino libraries' directory such as `~/Arduino/libraries/`.
113+
114+
### VS Code & PlatformIO
115+
116+
1. Install [VS Code](https://code.visualstudio.com/)
117+
2. Install [PlatformIO](https://platformio.org/platformio-ide)
118+
3. Install [**SmallProjects** library](https://platformio.org/lib/show/xxxxx/SmallProjects) or [**SmallProjects** library](https://platformio.org/lib/show/11463/SmallProjects) by using [Library Manager](https://platformio.org/lib/show/xxxxx/SmallProjects/installation). Search for **SmallProjects** in [Platform.io Author's Libraries](https://platformio.org/lib/search?query=author:%22Khoi%20Hoang%22)
119+
4. Use included [platformio.ini](platformio/platformio.ini) file from examples to ensure that all dependent libraries will installed automatically. Please visit documentation for the other options and examples at [Project Configuration File](https://docs.platformio.org/page/projectconf.html)
120+
121+
94122
---
95123
---
96124

Loading
Loading

library.json

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"name": "SmallProjects",
3+
"version": "1.0.2",
4+
"keywords": "Other,Timing,Control,Device,Time,Timer,AVR,SAM-DUE,ESP32,ESP8266,SAMD,interrupt",
5+
"description": "Small Projects to demonstrate the usage of Khoi Hoang's libraries, such as ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc. These projects are much more complicated than the ordinary libraries' examples. Some can even be used directly in real-life.",
6+
"authors":
7+
{
8+
"name": "Khoi Hoang",
9+
"url": "https://github.com/khoih-prog",
10+
"maintainer": true
11+
},
12+
"repository":
13+
{
14+
"type": "git",
15+
"url": "//https://github.com/khoih-prog/SmallProjects"
16+
},
17+
"homepage": "https://github.com/khoih-prog/SmallProjects",
18+
"export": {
19+
"exclude": [
20+
"linux",
21+
"extras",
22+
"tests"
23+
]
24+
},
25+
"frameworks": "*",
26+
"platforms": "*",
27+
"examples": "examples/*/*/*.ino",
28+
"license": "MIT"
29+
}

library.properties

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ name=SmallProjects
22
version=1.0.2
33
author=Khoi Hoang <[email protected]>
44
maintainer=Khoi Hoang <[email protected]>
5-
sentence=Small Projects to demonstrate the usage of ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc.
6-
paragraph=
5+
sentence=Small Projects to demonstrate the usage of Khoi Hoang's libraries, such as ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc.
6+
paragraph=These projects are much more complicated than the ordinary libraries' examples. Some can even be used directly in real-life.
77
category=Other,Timing,Control,Device,Time,Timer,AVR,SAM-DUE,ESP32,ESP8266,SAMD,interrupt
88
url=https://github.com/khoih-prog/SmallProjects
99
architectures=*
1010
repository=https://github.com/khoih-prog/SmallProjects
1111
license=MIT
12+
includes=

0 commit comments

Comments
 (0)