Skip to content

Commit

Permalink
Comprehensive README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Jun 27, 2024
1 parent 35430d1 commit f118f1f
Showing 1 changed file with 56 additions and 3 deletions.
59 changes: 56 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,63 @@
# Uartix
<p align="center">
<img src="logo/uartix-round.png" width="162" />
</p>

<h1 align="center">Uartix</h1>

![Build CI](https://github.com/nthnn/Uartix/actions/workflows/build_ci.yml/badge.svg)
![Picoware CI](https://github.com/nthnn/Uartix/actions/workflows/picoware_ci.yml/badge.svg)
![Launcher Build CI](https://github.com/nthnn/Uartix/actions/workflows/launcher_build_ci.yml/badge.svg)

A strange dynamic programming language that performs mathematical computations on a connected Raspberry Pi Pico through UART connectivity.

> [!NOTE]
> Uartix is still underdevelopment. No further information available.
```utx
# Hello world example
greet = func(name)
render "Hello, " + name;
greet("world");
```

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

## Getting Started

### 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:

```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.

## Development Support

Uartix is an open-source project and is voluntarily developed. If you find Uartix useful and would like to support its continued development and improvement, you can make a donation.

<p align="center">
<a href="https://opencollective.com/nathanne-isip">
<img src="https://opencollective.com/webpack/donate/button@2x.png?color=blue" width="250" />
</a>
</p>

## License

[Uartix](https://github.com/nthnn/Uartix) programming language.
Copyright (c) 2024 Nathanne Isip.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).

0 comments on commit f118f1f

Please sign in to comment.