uniformize with litex cores and make things more clear about what LiteX vs Migen/MiSoC

This commit is contained in:
Florent Kermarrec 2018-02-22 11:52:10 +01:00
parent aaf097056a
commit 64aa4ae4c0
3 changed files with 118 additions and 21 deletions

94
.gitignore vendored
View File

@ -1,5 +1,89 @@
__pycache__ # Byte-compiled / optimized / DLL files
*.pyc __pycache__/
*.egg-info *.py[cod]
*.vcd *$py.class
outgoing
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# IPython Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# dotenv
.env
# virtualenv
venv/
ENV/
# Spyder project settings
.spyderproject
# Rope project settings
.ropeproject

39
README
View File

@ -5,29 +5,42 @@
Migen inside Migen inside
Build your hardware, easily! Build your hardware, easily!
Copyright 2012-2018 Enjoy-Digital Copyright 2012-2018 / EnjoyDigital
[> Intro [> Intro
-------- --------
LiteX is an alternative to Migen/MiSoC maintained and used by Enjoy-Digital LiteX is an alternative to MiSoC maintained and used by Enjoy-Digital to build
to build our cores, integrate them in complete SoC and load/flash them to our cores, integrate them in complete SoC and load/flash them to the hardware
the hardware and experiment new features. and experiment new features.
The structure of LiteX is kept close to Migen/MiSoC to ease collaboration +---------------+
between projects and efforts are made to keep cores developed with LiteX |FPGA toolchains|
compatible with Migen/MiSoC. +----^-----+----+
| |
+--+-----v--+
+-------+ | |
| Migen +--------> |
+-------+ | | Your design
| LiteX +---> ready to be used!
| |
+----------------------+ | |
|LiteX Cores Ecosystem +--> |
+----------------------+ +-^-------^-+
(Eth,,SATA,,DRAM,,USB, | |
PCIe,Video,etc...) + +
board target
file file
[> License
---------- The structure of LiteX is kept close to MiSoC to ease collaboration between
LiteX is Copyright (c) 2012-2017 Enjoy-Digital under BSD Lisense. projects.
Since it is based on Migen/MiSoC, please also refer to LICENSE file in gen/soc
directory or git history to get correct copyrights.
[> Sub-packages [> Sub-packages
--------------- ---------------
gen: gen:
Provides specific or experimental modules to generate HDL that are not integrated Provides specific or experimental modules to generate HDL that are not integrated
in Migen. in Migen. (For now a full copy of Migen is included in gen, aim is is to only
keep specific or experimental modules)
build: build:
Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to

View File

@ -5,8 +5,8 @@ from setuptools import setup
from setuptools import find_packages from setuptools import find_packages
if sys.version_info[:3] < (3, 3): if sys.version_info[:3] < (3, 5):
raise SystemExit("You need Python 3.3+") raise SystemExit("You need Python 3.5+")
setup( setup(
@ -25,7 +25,7 @@ setup(
classifiers=[ classifiers=[
"Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)", "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
"Environment :: Console", "Environment :: Console",
"Development Status :: Beta", "Development Status :: Alpha",
"Intended Audience :: Developers", "Intended Audience :: Developers",
"License :: OSI Approved :: BSD License", "License :: OSI Approved :: BSD License",
"Operating System :: OS Independent", "Operating System :: OS Independent",