From 54488c0f4d6e9e953f1a0de3d578915a5e4ccddf Mon Sep 17 00:00:00 2001
From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Sat, 11 Apr 2020 19:52:08 +0200
Subject: [PATCH] README: switch to markdown.

---
 README => README.md | 47 ++++++++++++++++++++++++++++++---------------
 1 file changed, 31 insertions(+), 16 deletions(-)
 rename README => README.md (70%)

diff --git a/README b/README.md
similarity index 70%
rename from README
rename to README.md
index f7979e2..b1346d5 100644
--- a/README
+++ b/README.md
@@ -1,12 +1,17 @@
-             __   _ __      ____
-            / /  (_) /____ / __/______  ___  ___
-           / /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_)
-          /____/_/\__/\__/___/\__/\___/ .__/\__/
-                                     /_/
-           Copyright 2015-2019 / EnjoyDigital
+```
+                                 __   _ __      ____
+                                / /  (_) /____ / __/______  ___  ___
+                               / /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_)
+                              /____/_/\__/\__/___/\__/\___/ .__/\__/
+                                                         /_/
+                               Copyright 2015-2020 / EnjoyDigital
+
+                           A small footprint and configurable Logic Analyzer
+                                    core powered by Migen & LiteX
+```
+
+[![](https://travis-ci.com/enjoy-digital/litescope.svg?branch=master)](https://travis-ci.com/enjoy-digital/litescope) ![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)
 
-       A small footprint and configurable Logic Analyzer
-                core powered by Migen & LiteX
 
 [> Intro
 --------
@@ -55,13 +60,18 @@ enjoy-digital.fr.
 
 [> Getting started
 ------------------
-1. Install Python3 and your vendor's software
+1. Install Python 3.6+ and FPGA vendor's development tools.
+2. Install Migen/LiteX and the LiteX's cores:
 
-2. Obtain LiteX and install it:
-  git clone https://github.com/enjoy-digital/litex --recursive
-  cd litex
-  python3 setup.py develop
-  cd ..
+```sh
+$ wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py
+$ chmod +x litex_setup.py
+$ ./litex_setup.py init install --user (--user to install to user directory)
+```
+  Later, if you need to update all repositories:
+```sh
+$ ./litex_setup.py update
+```
 
 3. TODO: add/describe examples
 
@@ -69,9 +79,14 @@ enjoy-digital.fr.
 --------
 Unit tests are available in ./test/.
 To run all the unit tests:
-  ./setup.py test
+```sh
+$ ./setup.py test
+```
+
 Tests can also be run individually:
-  python3 -m unittest test.test_name
+```sh
+$ python3 -m unittest test.test_name
+```
 
 [> License
 ----------