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 3e24df2 commit 586ef78
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,12 +1,17 @@
__ _ __ ___ _________
/ / (_) /____ / _ \/ ___/ _/__
/ /__/ / __/ -_) ___/ /___/ // -_)
/____/_/\__/\__/_/ \___/___/\__/
```
__ _ __ ___ _________
/ / (_) /____ / _ \/ ___/ _/__
/ /__/ / __/ -_) ___/ /___/ // -_)
/____/_/\__/\__/_/ \___/___/\__/
Copyright 2015-2020 / EnjoyDigital
Copyright 2015-2020 / EnjoyDigital
A small footprint and configurable PCIe core
powered by Migen & LiteX
```

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

A small footprint and configurable PCIe core
powered by Migen & LiteX

[> Intro
--------
Expand All @@ -29,9 +34,11 @@ PHY:
- Intel Cyclone5 (up to PCIe Gen2 X4)
- 64-bit/128-bit datapath.
- Clock domain crossing.

Core:
- TLP layer
- Reordering

Frontend:
- DMA (with Scatter-Gather)
- Wishbone bridge
Expand All @@ -49,7 +56,6 @@ LitePCIe is already used in commercial and open-source designs:
------------------------
- add standardized interfaces (AXI, Avalon-ST)
- add support for PCIe Gen2 X8
- add Xilinx Ultrascale support
- add Intel Stratix support
- add Lattice support
- add more documentation
Expand All @@ -60,24 +66,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

2. Obtain LiteX and install it:
git clone https://github.com/enjoy-digital/litex --recursive
cd litex
python3 setup.py develop
cd ..
1. Install Python 3.6+ and FPGA vendor's development tools.
2. Install Migen/LiteX and the LiteX's cores:

```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

[> 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 586ef78

Please sign in to comment.