README: consistency between projects

This commit is contained in:
Florent Kermarrec 2017-06-22 17:00:16 +02:00
parent cf7ea12ec8
commit e2cb7bd829
1 changed files with 8 additions and 15 deletions

23
README
View File

@ -9,7 +9,7 @@
logic analyzer core powered by LiteX logic analyzer core powered by LiteX
[> Intro [> Intro
--------- --------
LiteScope is a small footprint and configurable embedded logic analyzer that you LiteScope is a small footprint and configurable embedded logic analyzer that you
can use in your FPGA and aims to provide a free, portable and flexible can use in your FPGA and aims to provide a free, portable and flexible
alternative to vendor's solutions! alternative to vendor's solutions!
@ -33,7 +33,7 @@ LiteScope can be used as LiteX library or can be integrated with your standard
design flow by generating the verilog rtl that you will use as a standard core. design flow by generating the verilog rtl that you will use as a standard core.
[> Features [> Features
------------ -----------
- IO peek and poke with LiteScopeIO - IO peek and poke with LiteScopeIO
- Logic analyser with LiteScopeAnalyzer: - Logic analyser with LiteScopeAnalyzer:
- Subsampling - Subsampling
@ -45,11 +45,11 @@ design flow by generating the verilog rtl that you will use as a standard core.
- Exports formats: .vcd, .sr(sigrok), .csv, .py, etc... - Exports formats: .vcd, .sr(sigrok), .csv, .py, etc...
[> Proven [> Proven
---------- ---------
LiteScope has already been used to investigate issues on commercial and open-source designs. LiteScope has already been used to investigate issues on commercial and open-source designs.
[> Possible improvements [> Possible improvements
------------------------- ------------------------
- add standardized interfaces (AXI, Avalon-ST) - add standardized interfaces (AXI, Avalon-ST)
- add protocols analyzers - add protocols analyzers
- add signals injection/generation - add signals injection/generation
@ -63,7 +63,7 @@ devel [AT] lists.m-labs.hk.
[> Getting started [> Getting started
------------------- ------------------
1. Install Python3 and your vendor's software 1. Install Python3 and your vendor's software
2. Obtain LiteX and install it: 2. Obtain LiteX and install it:
@ -84,16 +84,8 @@ devel [AT] lists.m-labs.hk.
python3 test_io.py (led blinker) python3 test_io.py (led blinker)
python3 test_analyzer.py (capture counter with analyzer) python3 test_analyzer.py (capture counter with analyzer)
[> Simulations
---------------
TODO
[> Tests
---------
TODO
[> License [> License
------------ ----------
LiteScope is released under the very permissive two-clause BSD license. Under LiteScope is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use LiteScope for closed-source the terms of this license, you are authorized to use LiteScope for closed-source
proprietary designs. proprietary designs.
@ -106,7 +98,7 @@ do them if possible:
- send us the modifications and improvements you have done to LiteScope. - send us the modifications and improvements you have done to LiteScope.
[> 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.
LiteScope is mainly developed and maintained by EnjoyDigital. LiteScope is mainly developed and maintained by EnjoyDigital.
@ -119,4 +111,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