Skip to content

Commit

Permalink
README: switch to markdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
enjoy-digital committed Apr 11, 2020
1 parent 6958c21 commit 41f3014
Showing 1 changed file with 33 additions and 18 deletions.
51 changes: 33 additions & 18 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
__ _ __ _ ___ __
/ / (_) /____| | / (_)__/ /__ ___
/ /__/ / __/ -_) |/ / / _ / -_) _ \
/____/_/\__/\__/|___/_/\_,_/\__/\___/
```
__ _ __ _ ___ __
/ / (_) /____| | / (_)__/ /__ ___
/ /__/ / __/ -_) |/ / / _ / -_) _ \
/____/_/\__/\__/|___/_/\_,_/\__/\___/
Copyright 2016-2018 / EnjoyDigital
Copyright 2016-2018 / TimVideos.us
Copyright 2016-2020 / EnjoyDigital
Copyright 2016-2020 / TimVideos.us
Small footprint and configurable video cores
powered by LiteX
```

[![](https://travis-ci.com/enjoy-digital/litevideo.svg?branch=master)](https://travis-ci.com/enjoy-digital/litevideo) ![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)

Small footprint and configurable video cores
powered by LiteX

[> Intro
--------
Expand All @@ -27,6 +32,7 @@ design flow by generating the verilog rtl that you will use as a standard core.
PHY:
- HDMI input (Spartan6, 7-Series)
- HDMI output (Spartan6, 7-Series)

Core:
- DMA (input/output)
- Triple buffering (output)
Expand All @@ -52,24 +58,33 @@ enjoy-digital.fr.

[> Getting started
------------------
1. Install Python 3.5, Migen and FPGA vendor's development tools.
Get Migen from: https://github.com/m-labs/migen
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 example design(s)
3. TODO: add/describe examples

[> Tests
--------
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
----------
Expand Down

0 comments on commit 41f3014

Please sign in to comment.