From 09bb320a650e0f755de872986351b174ec8807dc Mon Sep 17 00:00:00 2001 From: Gareth McMullin Date: Wed, 29 Jun 2016 08:56:09 +1200 Subject: [PATCH] Change readme to markdown and add Travis and Gitter badges. --- README | 1 - README.md | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 77036712..00000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -See https://github.com/blacksphere/blackmagic/wiki diff --git a/README.md b/README.md new file mode 100644 index 00000000..f4751af5 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +Black Magic Probe +================= + +[![Build Status](https://travis-ci.org/blacksphere/blackmagic.svg?branch=master)](https://travis-ci.org/blacksphere/blackmagic) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/blacksphere/blackmagic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +Firmware for the Black Magic Debug Probe. + +The Black Magic Probe is a modern, in-application debugging tool for +embedded microprocessors. It allows you see what is going on 'inside' an +application running on an embedded microprocessor while it executes. It is +able to control and examine the state of the target microprocessor using a +JTAG or Serial Wire Debugging (SWD) port and on-chip debug logic provided +by the microprocessor. The probe connects to a host computer using a +standard USB interface. The user is able to control exactly what happens +using the GNU source level debugging software, GDB. + +See online documentation at https://github.com/blacksphere/blackmagic/wiki +