Skip to content

Commit

Permalink
update pplib install docs (#797)
Browse files Browse the repository at this point in the history
  • Loading branch information
mjansen4857 authored Oct 4, 2024
1 parent 7446b22 commit 176beee
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions Writerside/topics/pplib-Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,42 @@
PathPlannerLib can be added to your robot code project using the "Install New Libraries (online)" feature in VSCode
using the following JSON file URL:

> **Note**
>
> The main PathPlannerLib json file will not be updated for beta versions. To use the beta, you will need to use the
> beta json file below. Once PathPlannerLib is fully released after kickoff, you will need to switch back to the main
> vendor json file.
>
{style="note"}

<br/>

```text
https://3015rangerrobotics.github.io/pathplannerlib/PathplannerLib.json
```

**Beta Version**

To install the beta version of PathPlannerLib, use the following vendor json file

```text
https://3015rangerrobotics.github.io/pathplannerlib/PathplannerLib-beta.json
```

**Legacy Versions**

The following legacy PathPlannerLib json files can be used to install the last release from previous years for
compatibility with old robot code projects.

<br/>

<u>2024:</u>
```text
https://3015rangerrobotics.github.io/pathplannerlib/PathplannerLib2024.json
```

<br/>

<u>2023:</u>
```text
https://3015rangerrobotics.github.io/pathplannerlib/PathplannerLib2023.json
Expand All @@ -44,6 +67,14 @@ The Python version is compatible with RobotPy and available to install from PyPI
pip install robotpy-pathplannerlib
```

**Beta Version**

<br/>

```text
pip install robotpy-pathplannerlib --pre
```

</tab>
<tab title="LabVIEW">

Expand Down

0 comments on commit 176beee

Please sign in to comment.