Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
volf52 committed Dec 26, 2020
1 parent 58d357d commit eb524e5
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# pyasm-nand2tetris
# PyASM Assembler

![Run Python Tests](https://github.com/volf52/pyasm-nand2tetris/workflows/Run%20Python%20Tests/badge.svg?branch=main)
![Python Tests](https://github.com/volf52/pyasm-nand2tetris/workflows/Run%20Python%20Tests/badge.svg?branch=main)

ASM Assembler for the "Hack" Architecture from [Nand2Tetris](https://www.nand2tetris.org)

---
### Installation (shorter way):

- Download the wheel file from the [latest release](https://github.com/volf52/pyasm-nand2tetris/releases/latest).
- Install using pip (preferably in a separate virtual environment). You can use [pipx](https://pipxproject.github.io/pipx) to easily install the wheel file in a separate env, and expose the cli command.
- Have fun using `pyasm`. Run `pyasm --help` to check the commands and related options.

---
### Build from source:
- Install poetry from https://python-poetry.org.
- Clone this repo and cd into it.
- Run poetry install to create the virtualenv and install the packages.
- `poetry run pytest` to run the tests.
- `poetry build` to build the package into `dist`.
- Now you can install the package from the `dist` dir.

ASM Assembler for the "Hack" Architecture from Nand2Tetris

0 comments on commit eb524e5

Please sign in to comment.