Skip to content

Commit

Permalink
Add more clear manual install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
suchmememanyskill committed Apr 15, 2024
1 parent 356c78e commit 9e739de
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 9 deletions.
29 changes: 20 additions & 9 deletions Build.md → Manual_Install.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,38 @@
# Building
# Manual install

## Running a developer build
## Flashing a build via the commandline

On every change made in this repository, [Github Actions](https://github.com/suchmememanyskill/CYD-Klipper/actions) automatically builds the firmware images for various screens. You can run one of these images as follows:
#### Release firmware image

1. Go to [the releases tab](https://github.com/suchmememanyskill/CYD-Klipper/releases), and download the latest `firmware.zip` release.
2. Open the firmware.zip archive you just downloaded, open the corresponding folder for your screen, then extract `merged_firmware.bin`

This merged_firmware.bin file is a ready to flash image. Note that flashing this image does wipe your current configuration.

#### Developer firmware image
On every change made in this repository, [Github Actions](https://github.com/suchmememanyskill/CYD-Klipper/actions) automatically builds the firmware images for various screens.

#### Getting a firmware image
0. Make sure you are logged into github
1. Go to a [Github Actions](https://github.com/suchmememanyskill/CYD-Klipper/actions) build summary, then download the `firmware` Artifact.
2. Open the firmware.zip archive you just downloaded, open the corresponding folder for your screen, then extract `merged_firmware.bin`

This merged_firmware.bin file is a ready to flash image. Note that flashing this image does wipe your current configuration.

#### Flashing merged_firmware.bin
### Flashing merged_firmware.bin
1. Download and extract [esptool](https://github.com/espressif/esptool/releases) to a new folder
- For windows, download `esptool-v4.7.0-win64.zip`
2. Open a terminal window and navigate to this new folder containing esptool
- In windows, you can type cmd and press enter in the address bar in explorer to jump to the folder in cmd ![cmd](readme/cmd.jpg)
3. Move `merged-firmware.bin` into this new folder
4. Connect the display to your computer
5. Execute the command `esptool write_flash 0x0 merged-firmware.bin`
5. Execute the command `esptool write_flash 0x0 merged_firmware.bin`
- Don't forget to hold down the boot button on the display

## Building via PlatformIO
## Building & Flashing via PlatformIO

0. Install [Visual Studio Code](https://code.visualstudio.com/) and install the PlatformIO IDE plugin.
0. Install the following tools:
- [Visual Studio Code](https://code.visualstudio.com/) and install the PlatformIO IDE plugin.
- [Git](https://git-scm.com/download/win)
1. Download the source code of CYD-Klipper
- This can be done via the `git clone https://github.com/suchmememanyskill/CYD-Klipper` command or via the green `<> Code` button on Github
2. Open the CYD-Klipper folder inside the CYD-Klipper folder in Visual Studio Code
Expand All @@ -34,4 +43,6 @@ This merged_firmware.bin file is a ready to flash image. Note that flashing this
5. Connect the display to your computer
6. Click 'Upload and Monitor'
- This will start compiling the code, and after upload it to the display
- Don't forget to hold the boot button while flashing. The screen will flash when the firmware is attempted to be flashed
- Don't forget to hold the boot button while flashing. The screen will flash when the firmware is attempted to be flashed

![platformio](readme/platformio.png)
Binary file added readme/platformio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9e739de

Please sign in to comment.