Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Levi-Lesches authored Oct 9, 2023
1 parent b543e41 commit e00396b
Showing 1 changed file with 3 additions and 8 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Rover Control Dashboard
# The Dashboard
The Rover Control Dashboard is a graphical desktop application the Binghamton University Rover Team will use to operate and monitor the rover. It is a vital part of our remote command station.

We are redesigning and rebuilding our remote operating interfaces using more modern toolkits to promote rapid development and deployment. Visit [BinghamtonRover/BurtOS-2](https://github.com/BinghamtonRover/BurtOS-2) for command software from the 2022 competition year.

## Structure

Every folder in this project has a purpose, but you’ll mostly need the `lib` folder.
Expand Down Expand Up @@ -30,11 +28,8 @@ A Dart library is technically just a file. To add more complexity, classes and f

## Compiling

Firstly, we're using [Protobuf](https://developers.google.com/protocol-buffers), which means we need to invoke the Protobuf compiler to generate Dart code before we can compile the dashboard. Thankfully, that's all handled by `package:build_runner`, the de facto code generator for Dart.
```
dart run build_runner build
```

Note that while Flutter technically supports multiple platforms, we focus our development on Windows. Compiling and launching on Mac or Linux is a plus though, as it lets us work on UI and other non-critical features.

To run a debug build, run the appropriate command for your computer:

```
Expand Down

0 comments on commit e00396b

Please sign in to comment.