README: switch to markdown.

This commit is contained in:
Florent Kermarrec 2020-04-11 19:19:03 +02:00
parent 92c30489ae
commit 705003e523
1 changed files with 32 additions and 16 deletions

View File

@ -1,12 +1,17 @@
__ _ __ ______ __ ```
/ / (_) /____ / __/ /_/ / __ _ __ ______ __
/ /__/ / __/ -_) _// __/ _ \ / / (_) /____ / __/ /_/ /
/____/_/\__/\__/___/\__/_//_/ / /__/ / __/ -_) _// __/ _ \
/____/_/\__/\__/___/\__/_//_/
Copyright 2012-2018 / EnjoyDigital Copyright 2012-2020 / EnjoyDigital
A small footprint and configurable Ethernet core
powered by Migen & LiteX
```
[![](https://travis-ci.com/enjoy-digital/liteeth.svg?branch=master)](https://travis-ci.com/enjoy-digital/liteeth) ![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)
A small footprint and configurable Ethernet core
powered by Migen & LiteX
[> Intro [> Intro
-------- --------
@ -26,9 +31,11 @@ design flow by generating the verilog rtl that you will use as a standard core.
PHY: PHY:
- MII, RMII 100Mbps PHYs. - MII, RMII 100Mbps PHYs.
- GMII / RGMII /1000BaseX 1Gbps PHYs. - GMII / RGMII /1000BaseX 1Gbps PHYs.
Core: Core:
- Configurable MAC (HW or SW interface) - Configurable MAC (HW or SW interface)
- ARP / ICMP / UDP (HW or SW) - ARP / ICMP / UDP (HW or SW)
Frontend: Frontend:
- Etherbone (Wishbone over UDP: Slave or Master support) - Etherbone (Wishbone over UDP: Slave or Master support)
@ -52,14 +59,18 @@ enjoy-digital.fr.
[> Getting started [> Getting started
------------------ ------------------
1. Install Python 3.5, Migen and FPGA vendor's development tools. 1. Install Python 3.6+ and FPGA vendor's development tools.
Get Migen from: https://github.com/m-labs/migen 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. Check out /examples/versa_ecp5_udp_loopback for a good practical example of how to get 3. Check out /examples/versa_ecp5_udp_loopback for a good practical example of how to get
started with the Liteeth core solo in an FPGA. started with the Liteeth core solo in an FPGA.
@ -68,9 +79,14 @@ started with the Liteeth core solo in an FPGA.
-------- --------
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
---------- ----------