https://github.com/patopesto/sublime-text-pio-syntax

Sublime Text syntax for the RPI PIO Assembly language
https://github.com/patopesto/sublime-text-pio-syntax

pio rpi-pico sublime sublime-text syntax-highlighting

Last synced: about 16 hours ago
JSON representation

Sublime Text syntax for the RPI PIO Assembly language

• Host: GitHub
• URL: https://github.com/patopesto/sublime-text-pio-syntax
• Owner: patopesto
• License: mit
• Created: 2023-11-05T03:02:58.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-03-10T17:50:59.000Z (10 months ago)
• Last Synced: 2024-11-11T01:21:03.658Z (about 2 months ago)
• Topics: pio, rpi-pico, sublime, sublime-text, syntax-highlighting
• Homepage:
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RaspberryPi PIO Assembly syntax

Sublime Text 4 syntax hightling package for the PIO Assembly language used in the RP2040 MCU (RPI Pico).  

File extension: `.pio`  

Also handles the embedded languages found in `.pio` files: `C` or `python`

## Usage

Once installed, the `PIO` syntax will be available in the list of syntaxes.

## Installation

### Using Package Control

If you have [Package Control](https://packagecontrol.io/installation) installed: `Command Palette` → `Install Package` → `PIO`

### Manually

Clone this repository in your local packages folder.  

If you are unsure as to where your local packages directory is, please consult the [docs](https://docs.sublimetext.io/guide/getting-started/basic-concepts.html#the-data-directory).  

Example (on MacOS):

```shell

cd ~/Library/Application\ Support/Sublime\ Text/Packages

git clone [email protected]:patopest/sublime-text-pio-syntax.git "PIO Syntax"

``` 

## Development

- Clone the repository in your local packages.

- Make edits to the `.sublime-syntax` files, the syntax reloads on save.

### Tests

- Any file with the names starting with `syntax_test_` can be used as a test.

- Open the file and run `Tools > Build` (or `CMD`+`B` on macOS).

Sublime's docs about test files: [here](https://www.sublimetext.com/docs/syntax.html#testing)

### Useful documentation:

- [RP2040 datasheet](https://datasheets.raspberrypi.com/rp2040/rp2040-datasheet.pdf)

- [C SDK documentation as PDF](https://datasheets.raspberrypi.com/pico/raspberry-pi-pico-c-sdk.pdf)

- [C SDK documentation on Web](https://www.raspberrypi.com/documentation/pico-sdk/)

- [Sublime Syntax Definitions](https://www.sublimetext.com/docs/syntax.html#testing)

- [Sublime Syntax Scopes](https://www.sublimetext.com/docs/scope_naming.html#)