-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from ThomasHumper/patch-1
Enhance README with Professional Tone and Improved Formatting 🎨
- Loading branch information
Showing
1 changed file
with
28 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,42 @@ | ||
# Callisto | ||
Callisto is a reverse polish notation programming | ||
language inspired by YSL-C3 and Forth | ||
|
||
It also has a subset called CallistoScript made for scripting languages like Lua, and | ||
it's still sort of low level | ||
Callisto is a reverse Polish notation programming language, inspired by YSL-C3 and Forth. It also includes a subset called CallistoScript, designed for scripting languages like Lua, while still maintaining a relatively low-level approach. | ||
|
||
## Supported targets | ||
- x86 real mode, MS-DOS (complete) | ||
- x86_64 Linux, macOS (complete) | ||
- ARM64 Linux (complete) | ||
- Uxn (complete, `implement` broken, see #6) | ||
- Lua (complete, subset CallistoScript) | ||
## Supported Targets | ||
|
||
- **x86 Real Mode, MS-DOS:** Fully supported | ||
- **x86_64 Linux, macOS:** Fully supported | ||
- **ARM64 Linux:** Fully supported | ||
- **Uxn:** Fully supported (note: `implement` is broken, see [issue #6](#6)) | ||
- **Lua:** Fully supported (subset: CallistoScript) | ||
|
||
## Build Instructions | ||
|
||
To build the Callisto compiler, you will need a [D compiler](https://dlang.org/download.html). Once installed, build the project using the following command: | ||
|
||
## Build | ||
You need a [D compiler](https://dlang.org/download.html) to build the Callisto compiler | ||
``` | ||
dub build | ||
``` | ||
|
||
## Try it | ||
Note: to use the example programs, you will need the `std` submodule in this repository, | ||
which you can get by cloning recursively or | ||
doing `git submodule update --init --remote --recursive` | ||
## Getting Started | ||
|
||
### Running Example Programs | ||
|
||
Before running example programs, ensure that the `std` submodule is included in your repository. You can achieve this by cloning the repository recursively or running the following command: | ||
|
||
``` | ||
git submodule update --init --remote --recursive | ||
``` | ||
|
||
Example programs are located in the `examples` directory. To compile and run an example, use: | ||
|
||
There are some example programs in the `examples` folder, which you can compile | ||
and run like this: | ||
``` | ||
cac examples/exampleNameHere.cal -i std -o out | ||
cac examples/<exampleName>.cal -i std -o out | ||
./out | ||
``` | ||
|
||
To learn more about Callisto, read the [docs](https://callisto.mesyeti.uk/docs) | ||
For more detailed information about Callisto, please refer to the [official documentation](https://callisto.mesyeti.uk/docs). | ||
|
||
## Community and Support | ||
|
||
## Support/talk | ||
`#callisto-lang` on irc.libera.chat | ||
For support or discussions, join the `#callisto-lang` channel on [irc.libera.chat](https://libera.chat). |