__   _ __      ______  __                    __
         / /  (_) /____ / __/ /_/ /  ___ _______  ___ / /_
        / /__/ / __/ -_) _// __/ _ \/ -_) __/ _ \/ -_) __/
       /____/_/\__/\__/___/\__/_//_/\__/_/ /_//_/\__/\__/

           Copyright 2012-2015 / EnjoyDigital
                florent@enjoy-digital.fr

       A small footprint and configurable Ethernet core
                  developed by EnjoyDigital

[> Intro
---------
LiteEthernet provides a small footprint and configurable Ethernet core.

LiteEthernet is part of LiteX libraries whose aims are to lower entry level of
complex FPGA IP cores by providing simple, elegant and efficient implementations
ofcomponents used in today's SoC such as Ethernet, SATA, PCIe, SDRAM Controller...

The core uses simple and specific streaming buses and will provides in the future
adapters to use standardized AXI or Avalon-ST streaming buses.

Since Python is used to describe the HDL, the core is highly and easily
configurable.

LiteEthernet uses technologies developed in partnership with M-Labs Ltd:
 - Migen enables generating HDL with Python in an efficient way.
 - MiSoC provides the basic blocks to build a powerful and small footprint SoC.

LiteEthernet can be used as a Migen/MiSoC library (by simply installing  it
with the provided setup.py) or can be integrated with your standard design flow
by generating the verilog rtl that you will use as a standard core.

[> Features
-----------
- Ethernet MAC with various interfaces and various PHYs (GMII, MII, Loopback)

[> Possibles improvements
-------------------------
- add standardized interfaces (AXI, Avalon-ST)
- add DMA interface to MAC
- add hardware ARP table
- add hardware IP layer
- add hardware UDP layer
- add hardware Etherbone support
- ... See below Support and Consulting :)

If you want to support these features, please contact us at florent [AT]
enjoy-digital.fr. You can also contact our partner on the public mailing list
devel [AT] lists.m-labs.hk.


[> Getting started
------------------
  XXX

[> Simulations:
  XXX

[> Tests :
  XXX

[> License
-----------
LiteEthernet is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteEthernet for closed-source
proprietary designs.
Even though we do not require you to do so, those things are awesome, so please
do them if possible:
 - tell us that you are using LiteEthernet
 - cite LiteEthernet in publications related to research it has helped
 - send us feedback and suggestions for improvements
 - send us bug reports when something goes wrong
 - send us the modifications and improvements you have done to LiteEthernet.

[> Support and Consulting
--------------------------
We love open-source hardware and like sharing our designs with others.

LiteEthernet is developed and maintained by EnjoyDigital.

If you would like to know more about LiteEthernet or if you are already a happy
user and would like to extend it for your needs, EnjoyDigital can provide standard
commercial support as well as consulting services.

So feel free to contact us, we'd love to work with you! (and eventually shorten
the list of the possible improvements :)

[> Contact
E-mail: florent [AT] enjoy-digital.fr