README: switch to markdown.
This commit is contained in:
parent
72277ffd9b
commit
54488c0f4d
|
@ -1,12 +1,17 @@
|
||||||
|
```
|
||||||
__ _ __ ____
|
__ _ __ ____
|
||||||
/ / (_) /____ / __/______ ___ ___
|
/ / (_) /____ / __/______ ___ ___
|
||||||
/ /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_)
|
/ /__/ / __/ -_)\ \/ __/ _ \/ _ \/ -_)
|
||||||
/____/_/\__/\__/___/\__/\___/ .__/\__/
|
/____/_/\__/\__/___/\__/\___/ .__/\__/
|
||||||
/_/
|
/_/
|
||||||
Copyright 2015-2019 / EnjoyDigital
|
Copyright 2015-2020 / EnjoyDigital
|
||||||
|
|
||||||
A small footprint and configurable Logic Analyzer
|
A small footprint and configurable Logic Analyzer
|
||||||
core powered by Migen & LiteX
|
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)
|
||||||
|
|
||||||
|
|
||||||
[> Intro
|
[> Intro
|
||||||
--------
|
--------
|
||||||
|
@ -55,13 +60,18 @@ enjoy-digital.fr.
|
||||||
|
|
||||||
[> Getting started
|
[> 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:
|
```sh
|
||||||
git clone https://github.com/enjoy-digital/litex --recursive
|
$ wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py
|
||||||
cd litex
|
$ chmod +x litex_setup.py
|
||||||
python3 setup.py develop
|
$ ./litex_setup.py init install --user (--user to install to user directory)
|
||||||
cd ..
|
```
|
||||||
|
Later, if you need to update all repositories:
|
||||||
|
```sh
|
||||||
|
$ ./litex_setup.py update
|
||||||
|
```
|
||||||
|
|
||||||
3. TODO: add/describe examples
|
3. TODO: add/describe examples
|
||||||
|
|
||||||
|
@ -69,9 +79,14 @@ enjoy-digital.fr.
|
||||||
--------
|
--------
|
||||||
Unit tests are available in ./test/.
|
Unit tests are available in ./test/.
|
||||||
To run all the unit tests:
|
To run all the unit tests:
|
||||||
./setup.py test
|
```sh
|
||||||
|
$ ./setup.py test
|
||||||
|
```
|
||||||
|
|
||||||
Tests can also be run individually:
|
Tests can also be run individually:
|
||||||
python3 -m unittest test.test_name
|
```sh
|
||||||
|
$ python3 -m unittest test.test_name
|
||||||
|
```
|
||||||
|
|
||||||
[> License
|
[> License
|
||||||
----------
|
----------
|
Loading…
Reference in New Issue