Skip to content

Commit

Permalink
Add install info to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Molorius committed Jan 20, 2025
1 parent bc9516b commit 1a9eff3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ulp-forth

[![Latest Release](https://img.shields.io/github/v/release/Molorius/ulp-forth?sort=semver)](https://github.com/Molorius/ulp-forth/releases)
[![Test Status](https://github.com/Molorius/ulp-forth/actions/workflows/tests.yml/badge.svg)](https://github.com/Molorius/ulp-forth/actions?query=workflow%3Atests)
[![License: MPL 2.0](https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)

Expand Down Expand Up @@ -30,6 +31,7 @@ assembly. Toggling a pin is 4 times slower.
Copyright 2024-2025 Blake Felt [email protected]

# Contents
* [Installation](#installation)
* [Building ulp-forth](#building-ulp-forth)
* [Using ulp-forth](#using-ulp-forth)
* [Sharing memory](#sharing-memory)
Expand All @@ -45,6 +47,15 @@ Copyright 2024-2025 Blake Felt [email protected]
* [Standard Double words](#standard-double-words)
* [Optimizations](#optimizations)

# Installation

Releases can be found on the [release page](https://github.com/Molorius/ulp-forth/releases).

You can also build the latest tagged version from source with:
```bash
go install github.com/Molorius/ulp-forth@latest
```

# Building ulp-forth

The compiler can be built with `go build`. Unit tests are run on the
Expand Down

0 comments on commit 1a9eff3

Please sign in to comment.