From 64aa4ae4c02e73d57e918da711a88d0a7fdbd4d3 Mon Sep 17 00:00:00 2001 From: Florent Kermarrec Date: Thu, 22 Feb 2018 11:52:10 +0100 Subject: [PATCH] uniformize with litex cores and make things more clear about what LiteX vs Migen/MiSoC --- .gitignore | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++--- README | 39 ++++++++++++++-------- setup.py | 6 ++-- 3 files changed, 118 insertions(+), 21 deletions(-) diff --git a/.gitignore b/.gitignore index 9e102e668..72364f99f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,89 @@ -__pycache__ -*.pyc -*.egg-info -*.vcd -outgoing +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# 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 diff --git a/README b/README index 1bfa21be2..4231fd3a8 100644 --- a/README +++ b/README @@ -5,29 +5,42 @@ Migen inside Build your hardware, easily! - Copyright 2012-2018 Enjoy-Digital + Copyright 2012-2018 / EnjoyDigital [> Intro -------- -LiteX is an alternative to Migen/MiSoC maintained and used by Enjoy-Digital -to build our cores, integrate them in complete SoC and load/flash them to -the hardware and experiment new features. +LiteX is an alternative to MiSoC maintained and used by Enjoy-Digital to build +our cores, integrate them in complete SoC and load/flash them to the hardware +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 -compatible with Migen/MiSoC. + +---------------+ + |FPGA toolchains| + +----^-----+----+ + | | + +--+-----v--+ + +-------+ | | + | Migen +--------> | + +-------+ | | Your design + | LiteX +---> ready to be used! + | | ++----------------------+ | | +|LiteX Cores Ecosystem +--> | ++----------------------+ +-^-------^-+ + (Eth,,SATA,,DRAM,,USB, | | + PCIe,Video,etc...) + + + board target + file file -[> License ----------- -LiteX is Copyright (c) 2012-2017 Enjoy-Digital under BSD Lisense. -Since it is based on Migen/MiSoC, please also refer to LICENSE file in gen/soc -directory or git history to get correct copyrights. + +The structure of LiteX is kept close to MiSoC to ease collaboration between +projects. [> Sub-packages --------------- gen: 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: Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to diff --git a/setup.py b/setup.py index 230a1e2e1..8bc614c78 100755 --- a/setup.py +++ b/setup.py @@ -5,8 +5,8 @@ from setuptools import setup from setuptools import find_packages -if sys.version_info[:3] < (3, 3): - raise SystemExit("You need Python 3.3+") +if sys.version_info[:3] < (3, 5): + raise SystemExit("You need Python 3.5+") setup( @@ -25,7 +25,7 @@ setup( classifiers=[ "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)", "Environment :: Console", - "Development Status :: Beta", + "Development Status :: Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent",