Skip to content

Commit a941987

Browse files
authored
Merge pull request #127 from snidercs/martincarapia-patch-1
adding build instructions
2 parents 0000731 + d63ec90 commit a941987

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,11 @@ git clone git@github.com:snidercs/frc-bot-2025.git
1919
Please follow the code style as best as you can. See [docs/codestyle.md](docs/codestyle.md) for details.
2020

2121
## Building
22-
The primary firmware is in python to start with, while the others are needed for the development of LuaJIT ffi bindings.
23-
* **[Robotpy](docs/build-python.md)** (python)
24-
* [Gradle](docs/build-gradle.md) (C++)
25-
* [Meson](docs/build-meson.md) (C++ / LuaJIT)
26-
* [Docker](docs/docker.md) (CI / misc)
2722

28-
## Requirements
23+
### Requirements
2924
*All platforms* need to have the [latest WPIlib](https://github.com/wpilibsuite/allwpilib/releases) installed as well as [Python](https://www.python.org/downloads/). If you're wanting to dabble in Lua and build-systems development, then you'll also need [Meson](https://mesonbuild.com/Getting-meson.html) and [CMake](https://cmake.org).
3025

31-
## About Linux
26+
## Linux
3227
Development using Linux is *highly recommended* as all the tools are readily available. The following command will install the above (minus wpilib) plus some extras needed for compiling WPIlib directly.
3328

3429
```bash
@@ -43,3 +38,24 @@ sudo apt install build-essential gcc-multilib g++-multilib cmake python3 python3
4338
## Windows
4439
* **python**: Robotpy recommends the official installer.
4540
* **Visual Studio**: For the C++ compiler.
41+
42+
43+
### LuaJIT ffi bindings
44+
The primary firmware is in python to start with, while the others are needed for the development of LuaJIT ffi bindings.
45+
46+
* [Gradle](docs/build-gradle.md) (C++)
47+
* [Meson](docs/build-meson.md) (C++ / LuaJIT)
48+
* [Docker](docs/docker.md) (CI / misc)
49+
50+
### Robotpy
51+
* **[Robotpy](docs/build-python.md)** (python)
52+
53+
```bash
54+
cd frc-bot-2025/pybot
55+
robotpy sync # This will Download RoboRIO requirements and installs requirements locally
56+
robotpy deploy --skip-tests # To avoid all of the dumb questions
57+
# or
58+
robotpy sim # To run the simulator
59+
```
60+
61+

0 commit comments

Comments
 (0)