Fixing up readme

5a48690b · Dave Newbold · e46dac48 · 5a48690b
Commit 5a48690b authored Apr 06, 2017 by Dave Newbold
Hide whitespace changes
Inline Side-by-side

Showing with 16 additions and 19 deletions

README.md README.md +16 -19

No files found.
--- a/README.md
+++ b/README.md
-### What is this repository for? ###

-* Readout firmware and test software for the SOLID experiment
-* Current version is v8 (clone from tags/v8)
+This repository contains readout firmware and test software for the SOLID experiment

-### How do I get set up? ###
+Current version is v8 (clone from tags/v8)

 The master firmware uses the [ipbb](https://github.com/ipbus/ipbb) build tool, and requires the ipbus system firmware.
 The following example procedure should build a board image for the 64 channel readout board. Note that a reasonably up-to-date
 operating system (e.g. Centos7) is required.

-
-mkdir work
-cd work
-curl -L https://github.com/ipbus/ipbb/archive/v0.2.3.tar.gz | tar xvz
-source ipbb-0.2.3/env.sh
-ipbb init build
-cd build
-ipbb add git https://github.com/ipbus/ipbus-firmware.git -b tags/ipbus_2_0_v1
-ipbb add git BITBUCKET-URL -b tags/v8
-ipbb proj create vivado 64chan solid:projects/64chan_test
-cd proj/64chan
-ipbb vivado project
-ipbb vivado impl
-ipbb vivado bitfile
-ipbb vivado package
+	mkdir work
+	cd work
+	curl -L https://github.com/ipbus/ipbb/archive/v0.2.3.tar.gz | tar xvz
+	source ipbb-0.2.3/env.sh
+	ipbb init build
+	cd build
+	ipbb add git https://github.com/ipbus/ipbus-firmware.git -b tags/ipbus_2_0_v1
+	ipbb add git BITBUCKET-URL -b tags/v8
+	ipbb proj create vivado 64chan solid:projects/64chan_test
+	cd proj/64chan
+	ipbb vivado project
+	ipbb vivado impl
+	ipbb vivado bitfile
+	ipbb vivado package

 ### Who do I talk to? ###