mirror of
https://github.com/myhdl/myhdl.git
synced 2024-12-14 07:44:38 +08:00
4f8b1df02c
* Updating README.md to show alternative solutions to insatll MyHDL instead of installing from the *lagging* PyPI * removing *stale* link to Travis CI build status; need to find build status of GitHub Actions? updating link to Discourse * getting Discourse image from third-party web-site * replacing thirdparty Discourse image by original version from Discourse web-site * trying to make the Discourse a bit smaller * second try to change the image size * third try * reformatting positions of *badges* * still reformatting ... * trying harder * adding empty lines after *badges* * editing text
82 lines
2.2 KiB
Markdown
82 lines
2.2 KiB
Markdown
MyHDL 0.11
|
|
==========
|
|
|
|
[](http://docs.myhdl.org/en/stable/manual/)
|
|
[](http://docs.myhdl.org/en/latest/manual)
|
|
|
|
[](https://gitter.im/myhdl/myhdl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
[<img src="https://d11a6trkgmumsb.cloudfront.net/original/3X/a/d/ad2526334012b2ad0c3421f9b6dd94bae2ede52f.svg" alt="Visit MyHDL at Discourse" align="left" height="36" width="134" >](https://discourse.myhdl.org)
|
|
<br><br><br>
|
|
|
|
|
|
What is MyHDL?
|
|
--------------
|
|
MyHDL is a free, open-source package for using Python as a hardware
|
|
description and verification language.
|
|
|
|
To find out whether MyHDL can be useful to you, please read:
|
|
|
|
- http://www.myhdl.org/start/why.html
|
|
|
|
License
|
|
-------
|
|
MyHDL is available under the LGPL license. See ``LICENSE.txt``.
|
|
|
|
Website
|
|
-------
|
|
The project website is located at http://www.myhdl.org
|
|
|
|
Documentation
|
|
-------------
|
|
The manual is available on-line:
|
|
|
|
- http://docs.myhdl.org/en/stable/manual
|
|
|
|
What's new
|
|
----------
|
|
To find out what's new in this release, please read:
|
|
|
|
- http://docs.myhdl.org/en/stable/whatsnew/0.11.html
|
|
|
|
Installation
|
|
------------
|
|
It is recommended to install MyHDL (and your project's other dependencies) in
|
|
a virtualenv.
|
|
|
|
Installing the latest stable release:
|
|
|
|
```
|
|
pip install myhdl
|
|
```
|
|
Unfortunately the version on PyPI is quite behind the current development status, so you are better off installing the *stable* master branch directly from this GitHub repository:
|
|
|
|
```
|
|
pip install git+https://github.com/myhdl/myhdl.git@master
|
|
```
|
|
|
|
To install a local clone of the repository:
|
|
|
|
```
|
|
pip install -e path/to/dir
|
|
```
|
|
|
|
To install a specific commit hash, tag or branch from git:
|
|
|
|
```
|
|
pip install git+https://github.com/myhdl/myhdl@f696b8
|
|
```
|
|
|
|
|
|
You can test the proper installation as follows:
|
|
|
|
```
|
|
cd myhdl/test/core
|
|
py.test
|
|
```
|
|
|
|
To install co-simulation support:
|
|
|
|
Go to the directory ``cosimulation/<platform>`` for your target platform
|
|
and following the instructions in the ``README.txt`` file.
|