Skip to content

Commit

Permalink
wrote a readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BattleCh1cken committed May 9, 2024
1 parent 9bc31de commit adc2dc3
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# PROS Build Action

[![Test action](https://github.com/LemLib/pros-build/actions/workflows/test.yml/badge.svg)](https://github.com/LemLib/pros-build/actions/workflows/test.yml)

## Usage

Here are the basics `steps` you'd need to build a pros project:

```yml
steps:
- uses: actions/checkout@v4
- uses: Lemlib/pros-build@v1
```
If your pros project contains a library, this action can automatically build it as a template, and then upload it as an artifact.
```yml
steps:
- uses: actions/checkout@v4
- uses: Lemlib/pros-build@v1
with:
library-path: lemlib # make sure to substitute this with the correct path
```

0 comments on commit adc2dc3

Please sign in to comment.