Skip to content

Commit 63fe9b4

Browse files
committed
Prepare for upcoming release
1 parent 1dbe60e commit 63fe9b4

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,31 @@ For a comprehensive list of supported tools, features and limitations, please re
4949
5050
## Installation
5151

52-
PyFPGA requires Python>=3.8.
52+
> **NOTE:** PyFPGA requires Python >= 3.8.
5353
54-
At the moment, it's only available as a git repository hosted on GitHub. It can be installed with pip:
54+
PyFPGA can be installed in several ways:
55+
56+
1. From PyPi using pip:
57+
58+
```
59+
pip install pyfpga
60+
```
61+
62+
2. From the GitHub repository:
5563

5664
```
5765
pip install 'git+https://github.com/PyFPGA/pyfpga#egg=pyfpga'
5866
```
5967

60-
Alternatively, you can get a copy of the repository either through git clone or downloading a tarball/zipfile, and then:
68+
3. Clone/download the repository and install it manually:
6169

6270
```
6371
git clone https://github.com/PyFPGA/pyfpga.git
6472
cd pyfpga
6573
pip install -e .
6674
```
6775

68-
> With `-e` (`--editable`) your application is installed into site-packages via a kind of symlink.
69-
> That allows pulling changes through git or changing the branch, avoiding the need to reinstall the package.
76+
> **NOTE:** with `-e` (`--editable`), the application is installed into site-packages via a symlink, which allows you to pull changes through git or switch branches without reinstalling the package.
7077
7178
## Similar projects
7279

pyfpga/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""PyFPGA"""
22

3-
__version__ = '0.3.0-dev'
3+
__version__ = '0.3.0'

0 commit comments

Comments
 (0)