Updated README.md inspired by Alan (https://github.com/alan707)

Alan sent a pull request to update the README.md with some markdown tweaks
and a SocketCAN logo. Good idea!
After creating a SocketCAN logo PNG in the can-logos repository we can
reference the PNG inside the linux-can organization.
A license file needs to be added too - but this has to be discussed on the
mailing list first.

Signed-off-by: Oliver Hartkopp <socketcan@hartkopp.net>
pull/29/merge
Oliver Hartkopp 2017-04-27 21:22:03 +02:00
parent cb33a55720
commit 2a2efbbc7f
1 changed files with 51 additions and 13 deletions

View File

@ -1,17 +1,55 @@
SocketCAN userspace utilities and tools
<p align="center">
<img src="https://github.com/linux-can/can-logos/raw/master/png/SocketCAN-logo-60dpi.png" alt="SocketCAN logo"/>
</p>
CAN is a message-based network protocol designed for vehicles
originally initially created by Robert Bosch GmbH. SocketCAN is a set
of open source CAN drivers and a networking stack contributed by
Volkswagen Research to the Linux kernel.
### SocketCAN userspace utilities and tools
This package contains some userspace utilities for Linux SocketCAN
subsystem: asc2log, bcmserver, canbusload, can-calc-bit-timing,
candump, canfdtest, cangen, cangw, canlogserver, canplayer, cansend,
cansniffer, isotpdump, isotprecv, isotpperf, isotpsend, isotpserver,
isotpsniffer, isotptun, log2asc, log2long, slcan_attach, slcand and
slcanpty.
This repository contains some userspace utilities for Linux CAN
subsystem (aka SocketCAN):
---
#### Basic tools to display, record, generate and replay CAN traffic
* candump :
* canplayer :
* cansend :
* cangen :
* cansniffer :
#### CAN access via IP sockets
* canlogserver :
* bcmserver :
* [socketcand](https://github.com/dschanoeh/socketcand) :
#### CAN in-kernel gateway configuration
* cangw :
#### CAN bus measurement and testing
* canbusload :
* can-calc-bit-timing :
* canfdtest :
#### ISO-TP tools [ISO15765-2:2016 for Linux](https://github.com/hartkopp/can-isotp)
* isotpsend :
* isotprecv :
* isotpsniffer :
* isotpdump :
* isotpserver :
* isotpperf :
* isotptun :
#### Log file converters
* asc2log :
* log2asc :
* log2long :
#### Serial Line Discipline configuration (for slcan driver)
* slcan_attach :
* slcand :
* slcanpty :
### Additional Information:
* [SocketCAN Documentation (Linux Kernel)](https://www.kernel.org/doc/Documentation/networking/can.txt)
* [Elinux.org CAN Bus Page](http://elinux.org/CAN_Bus)
* [Debian Package Description](https://packages.debian.org/sid/can-utils)
Description copied from https://packages.debian.org/sid/can-utils