Metadata-Version: 2.1
Name: pf-dev-tools
Version: 1.0.1
Summary: A collection of tools for Project Freedom projects
Project-URL: Homepage, https://didier.malenfant.net/ProjectFreedom/
Project-URL: Documentation, https://github.com/DidierMalenfant/pfTools#readme
Project-URL: Bug Tracker, https://github.com/DidierMalenfant/pfTools/issues
Project-URL: Source Code, https://github.com/DidierMalenfant/pfTools
Author-email: Didier Malenfant <coding@malenfant.net>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Keywords: ProjectFreedom,analoguepocket,fpga,openFPGA
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: pillow
Requires-Dist: scons
Requires-Dist: semver>=3
Requires-Dist: tomli>=1.1.0; python_version < '3.11'
Description-Content-Type: text/markdown

# pfTools

[![GPL-v3.0](https://img.shields.io/github/license/DidierMalenfant/pfTools)](https://spdx.org/licenses/GPL-3.0-or-later.html) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pf-dev-tools.svg)](https://python.org) [![PyPI - Version](https://img.shields.io/pypi/v/pf-dev-tools.svg)](https://pypi.org/project/pf-dev-tools)

A collection of tools for [Project Freedom](https://didier.malenfant.net/ProjectFreedom/) projects.

Copyright (c) 2023-present **Didier Malenfant**.

-----

### Pre-requistes

**pfTools** requires at least [Python](https://python.org) 3.10. Make sure you have a [supported version](http://didier.malenfant.net/blog/nerdy/2022/08/17/installing-python.html) of **Python** before proceeding.

It also uses the [git](https://git-scm.com) command. This should come built in on **macOS** and **Linux**.

### Installation

You can install **pfTools** by typing the following in a terminal window:
```console
pip install pf-dev-tools
```

### Usage

**pfTools**'s functionality is centered around the `pf` command.

To get more information on its use, just type:
```console
pf --help
```

### Trademarks

**openFPGA** and the **openFPGA** logo are trademarks of [**Analogue**](https://www.analogue.co/) Enterprises Ltd.
**Quartus** is a registered trademark of [**Intel**](https://intel.com/).

This project is not affiliated, associated with, sponsored or supported by neither **Analogue** nor **Intel**.

### License

**pfTools** is distributed under the terms of the [GPLv3.0](https://spdx.org/licenses/GPL-3.0-or-later.html) or later license.
