Skip to content

Commit

Permalink
Fix README characters and don't read as utf-8
Browse files Browse the repository at this point in the history
Pypi is a bit picky about the rst and there was a utf-8 character it
didn't accept at upload.
  • Loading branch information
wallento committed Jul 7, 2020
1 parent 592919d commit 7abb5c6
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ To initialize our master we have to do this::
timeout=10) # in clock cycle number


But in actuals port name are rarely the same has seen above. In this case – for
example actuals ports names are::
But in actuals port name are rarely the same has seen above. In this case
actuals ports names are for example::

input clock
input [1:0] io_wbs_adr_i,
Expand Down Expand Up @@ -164,10 +164,10 @@ the bus ::

At the end of the simulation, if we want to display the ``adr``, ``datrd`` and ``datwr`` values
on the bus we will do following for example ::

for transaction in wbm._recvQ:
wbm.log.info(f"{[f'@{hex(v.adr)}r{hex(v.datrd)}w{hex(0 if v.datwr is None else v.datwr)}' for v in transaction]}")

We can also register a callback function that will be called each time a
transaction occured::

Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import setuptools

with open("README.rst", "r", encoding="utf-8") as fh:
with open("README.rst", "r") as fh:
long_description = fh.read()

print(long_description)

setuptools.setup(
name="cocotbext-wishbone",
use_scm_version={
Expand All @@ -12,7 +14,6 @@
author="Staf Verhaegen, Mathias Kreider",
author_email="[email protected], [email protected]",
description="Cocotb Wishbone modules",
long_description=long_description,
packages=["cocotbext.wishbone"],
install_requires=['cocotb'],
setup_requires=[
Expand Down

0 comments on commit 7abb5c6

Please sign in to comment.