Skip to content

Commit

Permalink
added basic installation documentation, and reference docs for boards.
Browse files Browse the repository at this point in the history
  • Loading branch information
opensiriusfox committed Oct 7, 2023
1 parent 91ffa38 commit 6246142
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,37 @@
# Board definitions for Amaranth HDL

TODO
The Amaranth Board Definitions contain platform specific information for deploying Amaranth projects onto readily available and common FPGA hardware. The boards defined within this repository are listed within `amaranth_boards/`.

*TODO: describe a typical board file, or point to general Amarnath documentation.*

For a quick reference of the boards described by this repository, reference the [Boards Table](docs/boards_table.md) or see the board sources defined in [`amaranth_boards/`](amaranth_boards/) directly.

## Installation

After following the setup instructions for the core [Amaranth HDL tool chain](https://amaranth-lang.org/docs/amaranth/latest/install.html), the `amaranth_boards` package can be installed in the same location as site-packages or dist-packages. The boards package follows a conventional setup process for a source based python package.

### Setup Requirements

This guide assumes a supported version of Python and `pip` are available on the host system. Reference the [Amaranth HDL documentation](https://amaranth-lang.org/docs/amaranth/latest/install.html) for specific versions and detailed setup instructions for for python and pip.

Prior to attempting to install the boards package, ensure your system has the required setuptools packages available.

- `setuptools` > 67.0
- `setuptools_scm[toml]` > 6.2

If you find you are missing either setuptools package, running the following command should install them locally assuming `pip` is available.

```bash
pip install setuptools setuptools_scm[toml]
```

### Local Installation

Either clone a copy of the source code from the repository, or download a bundled copy of the current `main` branch from the releases on this page. From within the root directory of the repository run the following command to install the current release of the boards package to the current user's python packages directory.

```bash
pip install --user .
```

## License

Expand Down
Loading

0 comments on commit 6246142

Please sign in to comment.