Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to wiki for easy install and command line build. #58

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Add links to wiki for easy install and command line build. #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bbbd9d
Add links to wiki for easy install and command line build.
gkoh Oct 17, 2023
d214d89
Merge branch 'master' into 34-installation-info
gkoh Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ the following libraries:

## Installation

### Easy Install

The simplest way to get started is using `esphome-flasher` and the release binaries.
Follow the instructions on the wiki: [Easy Install](https://github.com/gkoh/furble/wiki/Easy-Install)

### PlatformIO

PlatformIO does everything assuming things are installed and connected properly.
In most cases it should be:
- clone the repository
Expand All @@ -121,6 +128,8 @@ In most cases it should be:
- OR plug in the M5Stack Core2
- `platformio run -e m5stack-core2 -t upload`

More details are on the wiki: [PlatformIO](https://github.com/gkoh/furble/wiki/Linux-Command-Line-(For-Developers))

## Usage

The top level menu has the following entries:
Expand Down