Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wputnam committed Feb 27, 2018
1 parent 82f015c commit 3dcd608
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -6,7 +6,7 @@ BetterCAN is a lightweight, TCP and TLS-like transport and session-layer based i

Here's a quick rundown of the main features:
- Utilizes the CAN FD data frame
- Transport layer with sequence numbering, sender information, and IP-esque checksum
- Transport layer with sequence numbering, sender information, and IP-esque checksum
- Session layer with connection-related data for SSM's algorithms
- Basic awareness features to determine suspicious activity and act on it
- Application and session data are encrypted using AES-256 block ciphers
Expand All @@ -30,21 +30,21 @@ The following tools and libraries are required before compilation:
Compile everything with `make` in the main project directory. To clean up the project files and executables, run `make clean`.

### Run

Establish your CAN bus network first. For a single virtual CAN network, type in:

```sh
$ sudo sh CANinterface.sh
```

Establish your CAN bus network first. For a single virtual CAN network, type in:

```sh
$ sudo sh CANinterface.sh
```

For each MCU you wish to run, start a new terminal tab and type in:

```sh
$ ./tcbm [ASCII char]
```

where `ASCII char` is the CAN ID that you wish to assign to the MCU.

where `ASCII char` is the CAN ID that you wish to assign to the MCU.

You'll need one SSM on the network. The ASCII ID for the SSM is `"` (34).

# Contribute
Expand All @@ -56,7 +56,7 @@ If you find any issues not already listed, please submit an issue request.
## Authors

* **William Putnam** - *Protocol design and coding* - [wputnam](https://github.com/wputnam)
* **Shunsuke Sakurai** - *Awareness algorithm design and coding* - [xxxxx](https://github.com/xxxxx)
* **Shunsuke Sakurai** - *Awareness algorithm design and coding* - [sak39](https://github.com/sak39)

## License

Expand Down

0 comments on commit 3dcd608

Please sign in to comment.