Skip to content

Commit

Permalink
fix: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ayushsharma82 committed Jul 29, 2024
1 parent ee65028 commit 80b93e6
Show file tree
Hide file tree
Showing 4 changed files with 2,858 additions and 2,913 deletions.
10 changes: 9 additions & 1 deletion docs/async-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_position: 7
One of the features of ElegantOTA is the async mode, which provides asynchronous web server functionality for handling OTA updates. This mode should only be enabled if you are using ESPAsyncWebServer library in your project/firmware.


### Dependencies
### Recommended Dependencies

#### For ESP8266

Expand All @@ -26,6 +26,14 @@ One of the features of ElegantOTA is the async mode, which provides asynchronous
- (khoih-prog) [AsyncTCP_RP2040W](https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0) @ **v1.2.0**
- (mathieucarbou) [ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer#v3.1.1) - **v3.1.1**

### Use of Unrecommended Dependencies (Experimental)

Incase your project is strictly dependent on a fork of dependency which is not listed above:

1. Please make sure to install ElegantOTA 'manually' using the steps provided in [installation guide](/docs/installation)

2. If you are using PlatformIO, open `library.json` file in ElegantOTA library folder and delete the `dependencies` parameter. This will disable auto installation of recommended dependencies.

### Enabling Async Mode

#### For Arduino IDE
Expand Down
40 changes: 32 additions & 8 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,50 @@ ElegantOTA requires no dependencies and runs out of the box with existing librar

---

### 1. Via Arduino IDE - Library Manager
## For Arduino IDE

### 1. Library Manager

Go to Sketch > Include Library > Library Manager > Search for "ElegantOTA" > Install

---
### 2. Manual Installation

### 2. Manual Install
#### For Windows

##### For Windows:
- Download the [Repository](https://github.com/ayushsharma82/ElegantOTA/archive/master.zip)
- Extract the .zip in `Documents > Arduino > Libraries > {Place "ElegantOTA" folder Here}`

##### For Linux:
- Download the [Repository](https://github.com/ayushsharma82/ElegantOTA/archive/master.zip)
- Extract the .zip in `Sketchbook > Libraries > {Place "ElegantOTA" folder Here}`
#### For Linux

- Download the [Repository](https://github.com/ayushsharma82/ElegantOTA/archive/master.zip)
- Extract the .zip in `Sketchbook > Libraries > {Place "ElegantOTA" folder Here}`

#### 3. Import through Arduino IDE

- Download the [Repository](https://github.com/ayushsharma82/ElegantOTA/archive/master.zip)
- Go to `Sketch > Include Library > Add .zip Library > Select the Downloaded .zip File.`

---
## For PlatformIO

### Required changes for PlatformIO

As ElegantOTA supports multiple architectures, PlatformIO will try to include all the dependencies automatically which will often result in compilation errors. To mitigate this issue, please follow these steps:

1. Delete `.pio/libdeps` folder (if it exists) in your project before proceeding.
2. Open `platformio.ini` file of your project.
3. Add the following line inside your `platformio.ini` file:

```ini
lib_compat_mode = strict
```

4. Save the changes to the `platformio.ini` file.

### 1. Library Manager

Go to PlatformIO Menu > Libraries > Search for "ElegantOTA" > Install in your project.

### 2. Manual Installation

- Download the [Repository](https://github.com/ayushsharma82/ElegantOTA/archive/master.zip)
- Extract the .zip in `lib` folder of your project
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 80b93e6

Please sign in to comment.