fa/README.md
Ari Archer 015bcd6a94
Fix the username in readme
Signed-off-by: Ari Archer <ari.web.xyz@gmail.com>
2022-07-26 15:48:16 +03:00

73 lines
1.6 KiB
Markdown

# [Fa](<https://en.wikipedia.org/wiki/Fa_(letter)>) programming language
> A rys-like stack based, reverse polish notation low-level programming
> language that transpiles down to assembly
# Note
Do not contribute to the python script, it will be deleted eventually,
for any ideas make an issue and also in **no way** is this currently
a production-friendly language
# Goal
Fa programming language is supposed to be similar to rys but
fixing a lot of issues it has, the initial name for fa was
rys++ but I ended up on fa, this language is going to be self-hosted
some time
# Try it online
Please don't be an ass on them, don't do stuff that
might break these compilers :)
- Online compiler by **@usernameeReal** (<https://github.com/usernameeReal>) <http://usernamee.duckdns.org:34353/>
- Online API by **@Elijahr2411** (<https://github.com/Elijahr2411>) <https://elijah-dev.tk/fa.php>
- Basic UI: <https://elijah-dev.tk/fa.html>
# Operating systems fa works on
- GNU/Linux
- FreeBSD
# System requirements
- `Fasm` compiler
- `Python3` (for now)
- Bash-completion (optional, for completions)
# Development requirements
- Curl
# Testing requirements
- coreutils
- Tested: FreeBSD, GNU
- BC
# Installation for developing
```bash
$ ./scripts/devsetup.sh
```
# Testing the compiler
- Install the compiler
- Run
```bash
$ ./scripts/test.sh
```
# Docker
Dockerfile was made by **@Elijahr2411** (https://github.com/Elijahr2411) for basic docker compilation,
usage:
```bash
docker run --platform amd64 -v {$filename}:/fa/a.fa fa-docker
```
Where `{$filename}` is your fa file.