Skip to content

Commit

Permalink
Readme: Improve formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Gutsche committed Jan 25, 2024
1 parent 5fe7a4c commit f493327
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


# Bit-Bots Software Stack

[![Test if all packages build](https://github.com/bit-bots/bitbots_main/actions/workflows/build.yml/badge.svg)](https://github.com/bit-bots/bitbots_main/actions/workflows/build.yml)
Expand All @@ -20,23 +18,23 @@ Full step-by-step instructions for installing the Bit-Bots software stack and RO

If you want to update this repo, all third party source files as well as the supplementing files, run

``` bash
``` shell
make pull-all
```

If you encounter any problems consider cleaning the third party source files (the `lib` folder) first:

**THIS DELETES ALL CHANGES YOU MADE TO THE THIRD PARTY SOURCE FILES**
**THIS DELETES ALL CHANGES YOU MADE TO THE THIRD PARTY SOURCE FILES!**

``` bash
``` shell
make fresh-libs
```

## Run auto formatting

To format all code in the repository, run

``` bash
``` shell
make format
```

Expand Down
10 changes: 5 additions & 5 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,31 @@ Five different tasks can be performed:

- Get help and list all arguments:

```bash
```shell
./deploy_robots.py --help
```

- Default usage: Run all tasks on the `nuc1` host:

```bash
```shell
./deploy_robots.py nuc1
```

- Make all robots ready for games. This also launch the teamplayer software on all robots:

```bash
```shell
./deploy_robots.py ALL
```

- Only run the sync and build tasks on the `nuc1` and `nuc2` hosts:

```bash
```shell
./deploy_robots.py --sync --build nuc1 nuc2
```

- Only build the `bitbots_utils` ROS package on the `nuc1` host:

```bash
```shell
./deploy_robots.py --package bitbots_utils nuc1
```

Expand Down

0 comments on commit f493327

Please sign in to comment.