Skip to content

Commit

Permalink
Well-detailed and comprehensive README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Jun 27, 2024
1 parent 195d1ea commit 28ea338
Showing 1 changed file with 61 additions and 2 deletions.
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
![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)
[![GitHub Issues](https://img.shields.io/github/issues/nthnn/Uartix.svg)](https://github.com/nthnn/Uartix/issues)
[![GitHub Stars](https://img.shields.io/github/stars/nthnn/Uartix.svg)](https://github.com/nthnn/Uartix/stargazers)
![GitHub repo size](https://img.shields.io/github/repo-size/nthnn/Uartix?logo=git&label=Repository%20Size)
[![License](https://img.shields.io/badge/license-GNU%20GPL%20v3-blue.svg)](https://github.com/nthnn/Uartix/blob/main/LICENSE)

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

Expand All @@ -21,11 +25,11 @@ greet("world");

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

## Why?
## Why Uartix?

- 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.
- Compared to many external co-processors, Uartix running on a Raspberry Pi Pico presents a highly cost-effective solution. The affordability of the Pico reduces overall project costs while still delivering substantial computational power for a variety of applications.
- 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.
Expand Down Expand Up @@ -89,6 +93,61 @@ Uartix is an open-source project and is voluntarily developed. If you find Uarti
</a>
</p>

## Contributing and Contributors

All contributions are welcome to make Uartix even better. Whether you want to report a bug, suggest new features, or contribute code, your contributions are highly appreciated.

### Issue Reporting

If you come across a bug, have a feature request, or wish to propose enhancements, we kindly encourage you to initiate the process by opening an issue on our GitHub [Issue Tracker](https://github.com/nthnn/Uartix/issues). Your feedback is invaluable in helping us refine and enhance the Uartix. To ensure we can address your concern effectively, we kindly request that you include as much pertinent information as possible. This may encompass a detailed description of the issue or feature request, and if applicable, specific steps to replicate the problem.

Your thorough input enables us to better understand and resolve the matter swiftly, contributing to the overall improvement of Uartix. Thank you for your contributions and for helping us create a more robust and user-friendly environment.

### Pull Requests

If you're eager to get involved and contribute your coding expertise to Uartix, we're thrilled to have you on board! To ensure a smooth and collaborative process, here's an outlined the following steps that you can follow:

1. Fork the Uartix repository to your GitHub account. And then clone it to your local machine.

```shell
git clone https://github.com/<your username>/Uartix.git
```

2. Create a new branch for your changes:

```shell
git checkout -b feature/<your feature name>
```

3. You can now make changes to the repository.

4. Commit your changes:

```shell
git add -A
git commit -m "Add your meaningful commit message here"
```

5. Push your changes to your forked repository:

```shell
git push origin feature/<your feature name>
```

6. Create a pull request (PR) from your branch to the main branch of the Uartix repository.

7. Your PR will be reviewed, and any necessary changes will be discussed and implemented.

8. Once your PR is approved, it will be merged into the main branch, and your contribution will be part of Uartix.

### Contributors

Finally, this section acknowledges and celebrates the individuals who have made significant contributions to the development and success of the project. Meet the dedicated and talented team members, developers, and collaborators who have played key roles in bringing Uartix to life and advancing its objectives.

- [Nathanne Isip](https://github.com/nthnn) — Original Author, Developer
- [Lady Selene](https://instagram.com/lady.selenee) — Artist, Illustrator


## License

[Uartix](https://github.com/nthnn/Uartix) programming language.
Expand Down

0 comments on commit 28ea338

Please sign in to comment.