Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
leroythelegend authored Sep 15, 2021
1 parent 2cba6c7 commit 0d5a822
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The CSV files can be used in a plotter, for example [PlotJuggler](https://github

## <a name="installation"/>Installation

For Linux and Mac users
### For Linux and Mac users

```shell
mkdir build
Expand All @@ -21,11 +21,26 @@ make
sudo make install
```

### For windows

This is what I did to build on windows (I'm no expert on windows)

- Installed free version of visual studio
- Installed vscode
- Open the repo in vscode
- Installed the C++ intelliSense from microsoft
- Installed the CMake Tools plugin from microsoft
- VSCode had a pop-up to configure to use CMake, I clicked yes
- Then clicked the build button at the bottom of VSCode
- This then built the executables in ./build/Debug

## <a name="usage"/>Usage

I have included [F1 2021 UDP Guide](doc/Data_Output_from_F1_2021%2351.docx) in the docs dir, there is a section "How do I enable the UDP Telemetry Output?".

For Linux and Mac users, open a terminal and run
**NOTE** The CSV files are written to the same directory (folder) the executable is run from.

Open a terminal and run (Windows users may need to set the PATH environment variable to the executable (risf1))

```
risf1 [port number (Default 20777)]
Expand Down

0 comments on commit 0d5a822

Please sign in to comment.