Skip to content

Commit

Permalink
Merge pull request #94 from codm/xzg-main
Browse files Browse the repository at this point in the history
README Update For CLI+LSP Users
  • Loading branch information
xyzroe authored Jul 16, 2024
2 parents 8e82b22 + 49f117c commit 24e7a64
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ Please follow the installation guide tailored to your hardware.

## 🛠️ Compiling from source

### Local

### VS Code
- You need npm and Python installed
- Install Visual Studio Code (VSC)
- Install PlatformIO extension to VSC
Expand All @@ -46,6 +45,23 @@ Please follow the installation guide tailored to your hardware.
- Open `XZG.code-workspace` in VSC
- Press "PlatformIO: Build" and wait until XZG*.bin are generated

### Linux CLI
- You need npm ad Python installed
- Install PlatformIO Core (it's in many package managers)
- Clone this repository
`git clone --recurse-submodules https://github.com/xyzroe/XZG.git`
- Use `pio run` to build default environment
- Binaries output to .pio/build/name_of_env/
- Use `pio run -t upload` to build and upload
firmware image
- Use `-e` flag to select a specific build:
`pio run -e env_name -t upload`

### Language Server Setup
- LSP (e.g. clangd and Neovim) users need to run
`pio run -t compiledb` to
generate a "compile_commands.json"

### Github
- Fork this repository;
- Made your changes;
Expand Down

0 comments on commit 24e7a64

Please sign in to comment.