README: consistency between projects

This commit is contained in:
Florent Kermarrec 2017-06-22 16:57:14 +02:00
parent 25d5674f33
commit bab0150c87
1 changed files with 13 additions and 10 deletions

23
README
View File

@ -9,7 +9,7 @@
[> Intro [> Intro
--------- --------
LiteDRAM provides a small footprint and configurable DRAM core. LiteDRAM provides a small footprint and configurable DRAM core.
LiteDRAM is part of LiteX libraries whose aims are to lower entry level of LiteDRAM is part of LiteX libraries whose aims are to lower entry level of
@ -48,7 +48,7 @@ Frontend:
- BIST. - BIST.
[> Possible improvements [> Possible improvements
------------------------- ------------------------
- add standardized interfaces (AXI, Avalon-ST) - add standardized interfaces (AXI, Avalon-ST)
- add support for Altera PHYs. - add support for Altera PHYs.
- add support for Lattice PHYs. - add support for Lattice PHYs.
@ -59,18 +59,20 @@ enjoy-digital.fr. You can also contact our partner on the public mailing list
devel [AT] lists.m-labs.hk. devel [AT] lists.m-labs.hk.
[> Getting started > Getting started
------------------ ------------------
XXX 1. Install Python3 and your vendor's software
[> Simulations: 2. Obtain LiteX and install it:
XXX git clone https://github.com/enjoy-digital/litex --recursive
cd litex
python3 setup.py install
cd ..
[> Tests : 3. TODO: add example design(s)
XXX
[> License [> License
----------- ----------
LiteDRAM is released under the very permissive two-clause BSD license. Under LiteDRAM is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteDRAM for closed-source the terms of this license, you are authorized to use LiteDRAM for closed-source
proprietary designs. proprietary designs.
@ -83,7 +85,7 @@ do them if possible:
- send us the modifications and improvements you have done to LiteDRAM. - send us the modifications and improvements you have done to LiteDRAM.
[> Support and consulting [> Support and consulting
-------------------------- -------------------------
We love open-source hardware and like sharing our designs with others. We love open-source hardware and like sharing our designs with others.
LiteDRAM is developed and maintained by EnjoyDigital. Initial development LiteDRAM is developed and maintained by EnjoyDigital. Initial development
@ -97,4 +99,5 @@ So feel free to contact us, we'd love to work with you! (and eventually shorten
the list of the possible improvements :) the list of the possible improvements :)
[> Contact [> Contact
----------
E-mail: florent [AT] enjoy-digital.fr E-mail: florent [AT] enjoy-digital.fr