simplify README.md so that it gets submitted to pypi
[soc.git] / setup.py
index 737c7c996e993552f93f940eca194d592b06b663..14cd4c6e9508c1a6b18bd5ace84897b9c9db6bb1 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -6,41 +6,43 @@ here = os.path.abspath(os.path.dirname(__file__))
 README = open(os.path.join(here, 'README.md')).read()
 NEWS = open(os.path.join(here, 'NEWS.txt')).read()
 
-
 version = '0.0.1'
 
-install_requires = [
-    #    'sfpy',
-    'ieee754fpu',  # needs to be installed manually from git.libre-soc.org
-    'pygdbmi',
-    'nmigen-soc',  # install manually from git.libre-soc.org
-    'ply',  # needs to be installed manually
-    'astor',
-    'pyvcd',  # for stylish GTKWave save files
+# using pip3 for ongoing development is a royal pain.  seriously not
+# recommended.  therefore a number of these dependencies have been
+# commented out.  *they are still required* - they will need installing
+# manually.
 
-    # install from https://salsa.debian.org/Kazan-team/power-instruction-analyzer
-    'power-instruction-analyzer',
+install_requires = [
+    #    'sfpy',    # needs manual patching
+    'libresoc-ieee754fpu',   # uploaded (successfully, whew) to pip
+    'libresoc-openpower-isa',  # uploaded (successfully, whew) to pip
+    # 'nmigen-soc', # install manually from git.libre-soc.org
 ]
 
 test_requires = [
     'nose',
+    # install pia from https://salsa.debian.org/Kazan-team/power-instruction-analyzer
+    'power-instruction-analyzer'
 ]
 
 setup(
-    name='soc',
+    name='libresoc',
     version=version,
-    description="A nmigen-based OpenPOWER multi-issue Hybrid CPU / VPU / GPU",
+    description="A nmigen-based OpenPOWER multi-issue Hybrid 3D CPU-VPU-GPU",
     long_description=README + '\n\n' + NEWS,
+    long_description_content_type='text/markdown',
     classifiers=[
-        "Topic :: Software Development :: Libraries",
-        "License :: OSI Approved :: LGPLv3+",
+        "Topic :: Software Development",
+        "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
         "Programming Language :: Python :: 3",
+        "Operating System :: OS Independent",
     ],
     keywords='nmigen ieee754 libre-soc soc',
     author='Luke Kenneth Casson Leighton',
     author_email='lkcl@libre-soc.org',
     url='http://git.libre-soc.org/?p=soc',
-    license='GPLv3+',
+    license='LGPLv3+',
     packages=find_packages('src'),
     package_dir={'': 'src'},
     include_package_data=True,