Initial commit.
authorwhitequark <whitequark@whitequark.org>
Fri, 6 Sep 2019 08:58:19 +0000 (08:58 +0000)
committerwhitequark <whitequark@whitequark.org>
Fri, 6 Sep 2019 09:00:45 +0000 (09:00 +0000)
.gitignore [new file with mode: 0644]
LICENSE.txt [new file with mode: 0644]
README.md [new file with mode: 0644]
nmigen_soc/__init__.py [new file with mode: 0644]
setup.py [new file with mode: 0644]

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..610c399
--- /dev/null
@@ -0,0 +1,4 @@
+# Python
+*.pyc
+/*.egg-info
+/.eggs
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644 (file)
index 0000000..6c78e3d
--- /dev/null
@@ -0,0 +1,28 @@
+Copyright (C) 2019 M-Labs Limited
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+Other authors retain ownership of their contributions. If a submission can
+reasonably be considered independently copyrightable, it's yours and we
+encourage you to claim it with appropriate copyright notices. This submission
+then falls under the "otherwise noted" category. All submissions are strongly
+encouraged to use the two-clause BSD license reproduced above.
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8022847
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# System on Chip toolkit for nMigen
+
+## CPU and peripheral building blocks
+
+TBD
+
+### License
+
+nMigen is released under the very permissive two-clause BSD license. Under the terms of this license, you are authorized to use nMigen for closed-source proprietary designs.
+
+See [LICENSE.txt](LICENSE.txt) file for full copyright and license info.
diff --git a/nmigen_soc/__init__.py b/nmigen_soc/__init__.py
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/setup.py b/setup.py
new file mode 100644 (file)
index 0000000..5a8baa2
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,25 @@
+from setuptools import setup, find_packages
+
+
+def scm_version():
+    def local_scheme(version):
+        return version.format_choice("+{node}", "+{node}.dirty")
+    return {"version_scheme": "guess-next-dev", "local_scheme": local_scheme}
+
+
+setup(
+    name="nmigen-soc",
+    use_scm_version=scm_version(),
+    author="whitequark",
+    author_email="whitequark@whitequark.org",
+    description="System on Chip toolkit for nMigen",
+    #long_description="""TODO""",
+    license="BSD",
+    setup_requires=["setuptools_scm"],
+    install_requires=["nmigen", "nmigen-stdio"],
+    packages=find_packages(),
+    project_urls={
+        "Source Code": "https://github.com/m-labs/nmigen-soc",
+        "Bug Tracker": "https://github.com/m-labs/nmigen-soc/issues",
+    },
+)