From 4f8b1df02c51e460b40d4e3b610eaf7f122641f5 Mon Sep 17 00:00:00 2001 From: Josy Boelen Date: Wed, 5 Apr 2023 13:31:55 +0100 Subject: [PATCH] Updating README.md to show alternative solutions to install MyHDL (#415) * 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 --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 854a25a6..b69f8859 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ MyHDL 0.11 ========== -[![Join the chat at https://gitter.im/myhdl/myhdl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/myhdl/myhdl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - [![Documentation Status](https://readthedocs.org/projects/myhdl/badge/?version=stable)](http://docs.myhdl.org/en/stable/manual/) [![Documentation Status](https://readthedocs.org/projects/myhdl/badge/?version=latest)](http://docs.myhdl.org/en/latest/manual) -[![Build Status](https://travis-ci.org/myhdl/myhdl.svg?branch=master)](https://travis-ci.org/myhdl/myhdl) + +[![Join the chat at https://gitter.im/myhdl/myhdl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/myhdl/myhdl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) + +[Visit MyHDL at Discourse](https://discourse.myhdl.org) +


+ What is MyHDL? -------------- @@ -46,20 +49,22 @@ 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: -To install the development version from github: ``` -pip install -e 'git+https://github.com/myhdl/myhdl#egg=myhdl +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 -e 'git+https://github.com/myhdl/myhdl@f696b8#egg=myhdl +pip install git+https://github.com/myhdl/myhdl@f696b8 ```