Skip to content

Commit eb402d8

Browse files
committed
docs: update installation instructions and add beta warning for NextFTC
1 parent f096a41 commit eb402d8

2 files changed

Lines changed: 34 additions & 15 deletions

File tree

src/guide/installation.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,44 @@ next: Subsystems
44

55
# Installation
66

7-
The first step to using NextFTC is installing it.
7+
> [!TIP]
8+
> If you are looking to learn NextFTC, take a look at the [guide](/guide/about).
9+
10+
NextFTC is our command-based framework. It has three building-blocks: commands,
11+
subsystems, and components. It also has an optional hardware module that
12+
provides built-in, ready-to-use hardware commands for almost all of your
13+
hardware needs.
14+
15+
::: danger
16+
These docs are for a beta version of NextFTC.
17+
There may be unexpected bugs and changes.
18+
Please let us know on Discord and GitHub if you find any issues!
19+
:::
20+
21+
## Installation
822

9-
In the TeamCode `build.gradle` file, go to the `dependencies`
10-
block.
11-
Add the following lines to the bottom:
23+
In the TeamCode `build.gradle`, go to the `dependencies` block.
24+
Add the following lines:
1225

1326
::: tabs key:gradle
1427

1528
== .gradle
1629

1730
```groovy
18-
implementation 'dev.nextftc:ftc:1.0.0'
19-
implementation 'dev.nextftc:hardware:1.0.0'
31+
implementation 'dev.nextftc:ftc:1.0.0-beta.3'
32+
implementation 'dev.nextftc:hardware:1.0.0-beta.3' // If you would like to use the hardware module
2033
```
2134

2235
== .gradle.kts
2336

2437
```kotlin
25-
implementation("dev.nextftc:ftc:1.0.0")
26-
implementation("dev.nextftc:hardware:1.0.0")
38+
implementation("dev.nextftc:ftc:1.0.0-beta.3")
39+
implementation("dev.nextftc:hardware:1.0.0-beta.3") // If you would like to use the hardware module
2740
```
2841

2942
:::
3043

31-
Press the `Sync Now` button that appeared as a banner at the top of your Gradle
32-
file.
44+
Then, press the `Sync Now` button that appeared as a banner at the top of your
45+
Gradle file.
3346

34-
*You're good to go!*
47+
*You're good to go!*

src/nextftc/index.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ subsystems, and components. It also has an optional hardware module that
88
provides built-in, ready-to-use hardware commands for almost all of your
99
hardware needs.
1010

11+
::: danger
12+
These docs are for a beta version of NextFTC.
13+
There may be unexpected bugs and changes.
14+
Please let us know on Discord and GitHub if you find any issues!
15+
:::
16+
1117
## Installation
1218

1319
In the TeamCode `build.gradle`, go to the `dependencies` block.
@@ -18,15 +24,15 @@ Add the following lines:
1824
== .gradle
1925

2026
```groovy
21-
implementation 'dev.nextftc:ftc:1.0.0'
22-
implementation 'dev.nextftc:hardware:1.0.0' // If you would like to use the hardware module
27+
implementation 'dev.nextftc:ftc:1.0.0-beta.3'
28+
implementation 'dev.nextftc:hardware:1.0.0-beta.3' // If you would like to use the hardware module
2329
```
2430

2531
== .gradle.kts
2632

2733
```kotlin
28-
implementation("dev.nextftc:ftc:1.0.0")
29-
implementation("dev.nextftc:hardware:1.0.0") // If you would like to use the hardware module
34+
implementation("dev.nextftc:ftc:1.0.0-beta.3")
35+
implementation("dev.nextftc:hardware:1.0.0-beta.3") // If you would like to use the hardware module
3036
```
3137

3238
:::

0 commit comments

Comments
 (0)