1
0
mirror of https://github.com/myhdl/myhdl.git synced 2025-01-24 21:52:56 +08:00

Merge pull request #16 from javValverde/master

Change format of README to markdown.
This commit is contained in:
jandecaluwe 2015-02-28 20:18:12 +01:00
commit 88487b8f7a
2 changed files with 24 additions and 13 deletions

5
.landscape.yaml Normal file
View File

@ -0,0 +1,5 @@
doc-warnings: yes
test-warnings: yes
strictness: veryhigh
max-line-length: 100
autodetect: yes

View File

@ -1,6 +1,10 @@
MyHDL 0.9
=========
[![Documentation Status](https://readthedocs.org/projects/myhdl/badge/?version=latest)](http://docs.myhdl.org/en/latest/manual)
[![Build Status](https://travis-ci.org/jandecaluwe/myhdl.svg?branch=master)](https://travis-ci.org/jandecaluwe/myhdl)
[![Code Health](https://landscape.io/github/javValverde/myhdl/master/landscape.svg?style=flat)](https://landscape.io/github/javValverde/myhdl/master)
What is MyHDL?
--------------
MyHDL is a free, open-source package for using Python as a hardware
@ -8,7 +12,7 @@ description and verification language.
To find out whether MyHDL can be useful to you, please read:
http://www.myhdl.org/start/why.html
[http://www.myhdl.org/start/why.html](http://www.myhdl.org/start/why.html)
License
-------
@ -18,10 +22,6 @@ Website
-------
The project website is located at http://www.myhdl.org
Development
-----------
The main development repo is at https://bitbucket.org/jandecaluwe/myhdl
Documentation
-------------
The manual is available on-line:
@ -32,33 +32,39 @@ What's new
----------
To find out what's new in this release, please read:
http://docs.myhdl.org/en/latest/whatsnew/0.8.html
[http://docs.myhdl.org/en/latest/whatsnew/0.8.html](http://docs.myhdl.org/en/latest/whatsnew/0.8.html)
Installation
------------
If you have superuser power, you can install MyHDL as follows:
python setup.py install
```
python setup.py install
```
This will install the package in the appropriate site-wide Python
package location.
Otherwise, you can install it in a personal directory, e.g. as
follows:
follows:
python setup.py install --home=$HOME
```
python setup.py install --home=$HOME
```
In this case, be sure to add the appropriate install dir to the
$PYTHONPATH.
$PYTHONPATH.
If necessary, consult the distutils documentation in the standard
Python library if necessary for more details;
or contact me.
You can test the proper installation as follows:
cd myhdl/test/core
python test_all.py
```
cd myhdl/test/core
python test_all.py
```
To install co-simulation support: