Skip to content

Commit

Permalink
Update README (#273)
Browse files Browse the repository at this point in the history
  • Loading branch information
abhaybd authored Oct 22, 2023
1 parent f56ee61 commit 9bd0a81
Showing 1 changed file with 0 additions and 141 deletions.
141 changes: 0 additions & 141 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ your distro.

# Project Setup

## Option 1: Easy Install

Make sure software is up to date (`sudo apt upgrade` is optional) and install required tools:
```bash
sudo apt update
Expand All @@ -48,145 +46,6 @@ cd Resurgence
```

Done! Continue on to the "IDE Setup" section.
## Option 2: Manual Install

### Install System Tools

First, update your software with
```bash
sudo apt update && sudo apt upgrade
```
Then, to install the tools, run
```bash
sudo apt install build-essential cmake git
```

### Setup Ubuntu repository
The project depends on many third-party libraries (mostly for sensors,
distributed by the sensor manufacturers) that we have packaged in a third-party
Ubuntu package repository. *Before continuing*, you should follow the
instructions at <https://huskyroboticsteam.github.io/ubuntu-repo> to set it
up. Afterwards, it should be fairly trivial to install the dependencies.

If you are on another Linux distribution, you may still have to build these
dependencies from source (especially if your system does not use the APT package
manager).

### Setup Project Repository

```bash
# Enter the home directory (or wherever you would like to put the project files).
# If you would like to put the project somewhere else, replace '~' with the folder path.
cd ~
# Clone the repository.
git clone https://github.com/huskyroboticsteam/Resurgence/
```

### Install Team Repositories
We have a few team libraries that we maintain internally.
HindsightCAN, for example, is a library developed by Electronics for interfacing with their
motors and sensors over the
[CAN](https://en.wikipedia.org/wiki/CAN_bus) bus; it is needed for packet definitions and utility functions and doesn't actually require support for a physical CAN bus.


Assuming the Ubuntu repository has been set up:
```bash
sudo apt install hindsight-can
```

### Install OpenCV

OpenCV and its contrib modules are packaged for Ubuntu. For other distributions, check to
see if `libopencv` and `libopencv-contrib` are included in your distribution's package
catalog.

To install, run the following command:
```bash
sudo apt install libopencv-dev libopencv-contrib-dev
```

### Install Catch2 (for unit testing)

If you are on Ubuntu, you can use our Ubuntu package repository.
Follow the instructions on <https://huskyroboticsteam.github.io/ubuntu-repo> first, and
then once you're finished, you can run
```bash
sudo apt install catch2
```

### Install URG library (Hokuyo lidar)

On Ubuntu, make sure you have followed the
[instructions to install our Ubuntu
repo](https://huskyroboticsteam.github.io/ubuntu-repo) and then just run:
```bash
sudo apt install urg-lidar
```

If you need to actually access the hardware (e.g. you're provisioning the jetson, don't do this on your personal machine unless you need to)

```bash
sudo cp src/lidar/50-usb-hokuyo-lidar.rules /etc/udev/rules.d
sudo udevadm control --reload-rules && sudo udevadm trigger
```

### Install RPLidar

```bash
sudo apt install rplidar
```

### Install [Eigen](http://eigen.tuxfamily.org)

On Ubuntu, you will be able to install via

```bash
sudo apt-get install libeigen3-dev
```

### Install JSON library

```bash
sudo apt-get install nlohmann-json3-dev
```

### Install WebSocket library

Websocket++ depends on a module from boost, so we'll need to install that too.
```bash
sudo apt install libwebsocketpp-dev libboost-system-dev
```

### Install GPS libraries


On Ubuntu, make sure you have followed the
[instructions to install our Ubuntu
repo](https://huskyroboticsteam.github.io/ubuntu-repo) and then just run:

```bash
sudo apt-get install ublox-linux gpsd gpsd-clients libgps-dev
```
(**NOTE**: `gpsd` is still required for legacy purposes, but will likely be
phased out when we completely switch to the new Ublox GPS hardware, so this
command installs `ublox-linux` as well to interact with that. Even `ublox-linux`
is a temporary solution; Electronics plans to integrate the GPS into a board
which we will query over CAN.)

### Install other libraries

We need the Frozen library for making immutable compile-time constant
containers, and argparse for parsing command-line arguments.

On Ubuntu, make sure you have followed the
[instructions to install our Ubuntu
repo](https://huskyroboticsteam.github.io/ubuntu-repo) and then just run:

```bash
sudo apt-get install frozen libargparse-dev libavutil-dev libx264-dev
```

Done!

# IDE Setup

Expand Down

0 comments on commit 9bd0a81

Please sign in to comment.