PRJ: prepare for release 3.0.1

Author: laborleben

README.rst

@@ -20,10 +20,17 @@ Basil is a modular data acquisition system and system testing framework in Pytho
 
 It also provides generic FPGA firmware modules for different hardware platforms and drivers for wide range of lab appliances.
 
-Documentation
-=============
-
-Documentation can be found under: http://basil.rtfd.org
+Features
+========
+Firmware:
+  - very simple single master bus definition
+  - multiple basic modules (SPI, SEQ, GPIO, I2C, JTAG)
+  - multiple interfaces (UART, USB2, USB3, Ethernet)
+Software:
+  - layer structure following hardware
+  - generation based on yaml file
+  - register abstract layer (RAL)
+  - simulator interface allows software test against simulated RTL (thanks to `cocotb <https://github.com/potentialventures/cocotb>`_)
 
 Installation
 ============
@@ -34,42 +41,37 @@ Clone the repository to get a copy of the source code (for developers):
 
     git clone https://github.com/SiLab-Bonn/basil.git
     cd basil
-    python setup.py develop
+    pip install -e .
 
 or install via PyPI into the Python's site-packages folder (for non-developers):
 
 .. code-block:: bash
 
     pip install basil_daq==version
 
-where version is a version number (e.g., 3.0.0)
+where version is a version number (e.g., 3.0.1)
 
 or install from git, when no PyPI package is available (for non-developers):
 
 .. code-block:: bash
 
     pip install git+https://github.com/SiLab-Bonn/basil.git@branch
 
-where branch is a branch name or tag (e.g., master or v3.0.0).
+where branch is a branch name or tag (e.g., master or v3.0.1).
 
 Check `.travis.yml <.travis.yml>`_ for installation/testing hints.
 
 Support
 =======
 
-Basil mailing list: `subscribe <https://e-groups.cern.ch/e-groups/EgroupsSubscription.do?egroupName=basil-devel>`_
+Please use GitHub's `issue tracker <https://github.com/SiLab-Bonn/basil/issues>`_ for bug reports/feature requests/questions.
 
-Features
-============
-Firmware:
-  - very simple single master bus definition
-  - multiple basic modules (SPI, SEQ, GPIO, I2C, JTAG)
-  - multiple interfaces (UART, USB2, USB3, Ethernet)
-Software:
-  - layer structure following hardware
-  - generation based on yaml file
-  - register abstract layer (RAL)
-  - simulator interface allows software test against simulated RTL (thanks to `cocotb <https://github.com/potentialventures/cocotb>`_)
+*For CERN users*: Feel free to subscribe to the `basil mailing list <https://e-groups.cern.ch/e-groups/EgroupsSubscription.do?egroupName=basil-devel>`_
+
+Documentation
+=============
+
+Documentation can be found under: https://basil.rtfd.org
 
 Example Projects:
 =================
@@ -78,7 +80,7 @@ Example Projects:
 - `fe65_p2 <https://github.com/SiLab-Bonn/fe65_p2>`_ - DAQ for FE65P2 prototype
 
 License
-============
+=======
 
 If not stated otherwise.
 

VERSION

@@ -1 +1 @@
-3.0.1.dev0
+3.0.1

setup.py

@@ -22,13 +22,15 @@
 with open('requirements.txt') as f:
     install_requires = f.read().splitlines()
 
+
 def package_files(directory):
     paths = []
     for (fpath, directories, filenames) in walk(directory):
         for filename in filenames:
             paths.append(path.join('..', fpath, filename))
     return paths
 
+
 setup(
     name='basil_daq',
     version=version,