Skip to content

Commit

Permalink
Improved repository README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Jun 27, 2024
1 parent 7b4c696 commit 195d1ea
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,63 @@ greet("world");

See the complete documentation [here](https://uartix.vercel.app).

## Why?

- The Raspberry Pi Pico, with its dual-core ARM Cortex-M0+ processor, offers a powerful yet affordable platform for hardware-level computation.
- Uartix provides a specialized environment where developers can perform complex mathematical operations directly on the hardware.
- On a Raspberry Pi Pico, Uartix offers a cost-effective solution compared to many external coprocessors.
- Uartix enhances the capabilities of the Raspberry Pi Pico by simplifying the development process with hardware-level mathematical calculations.
- The Raspberry Pi Pico, with its energy-efficient ARM Cortex-M0+ cores, offers a low-power solution for performing mathematical calculations which is perfect for Uartix runtime execution.
- Why not? I was bored when I started developing this.

## Getting Started

Before installing Uartix, ensure you have JDK 22 (or OpenJDK) installed on your system.

### Linux

On Ubuntu and other Linux distro with `dpkg`, you can simply download the `*.deb` file from [release page](https://github.com/nthnn/Uartix/releases), then install Uartix as shown below:
On Ubuntu and other Linux distro with `dpkg`, you can simply download the `*.deb` file from [release page](https://github.com/nthnn/Uartix/releases) and install Uartix with the following command:

```shell
sudo dpkg -i uartix_*.deb
```

### Windows

Download the `.zip` from the [release page](https://github.com/nthnn/Uartix/releases) for Windows. Extract it to `C:\uartix` then add `C:\uartix\bin` to your Environment Path variables.
Download the `.zip` file from the [release page](https://github.com/nthnn/Uartix/releases) for Windows. Extract it to `C:\` and add `C:\uartix\bin` to your Environment Path variables.

## Building from Source

To build Uartix from source on Ubuntu, run the following commands to automate the build process for `*.deb` and `*.zip` files, excluding the build process for the interpreter:

```shell
chmod +x ./build.sh
./build.sh
```

## Interpreter

To build the interpreter, open this repository in IntelliJ. From the menu, click `Build` and select `Build Artifacts > Build`.

## Launcher

To build the Uartix launcher, ensure you have Rust and cargo installed on your system. Also, install the MinGW and Rust toolchain for Windows target with the following commands:

```shell
sudo apt-get install mingw-w64
rustup target add x86_64-pc-windows-gnu
```

Then, build the launcher with:

```shell
cargo build --release
cargo build --release --target x86_64-pc-windows-gnu
```

## Firmware

To install the firmware on your Raspberry Pi Pico, connect the device to your system in flash mode. Download the UF2 binary of the Uartix firmware from the [release page](https://github.com/nthnn/Uartix/releases) and drag and drop it to your Raspberry Pi Pico storage.

## Development Support

Expand Down

0 comments on commit 195d1ea

Please sign in to comment.