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

Jump to bottom

README Update For CLI+LSP Users #94

Merged
merged 2 commits into from
Jul 16, 2024
Merged

README Update For CLI+LSP Users #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13755f1
README update for CLI and LSP users
Bixkitts Jul 16, 2024
49f117c
typo
Bixkitts Jul 16, 2024
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
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
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
Loading