jc/README
2025-05-21 21:06:26 -06:00

46 lines
1.1 KiB
Text

------
jc.jai
------
# Direct installation
cd [jai install dir]/modules
git clone https://git.brut.systems/judah/jc.jai.git jc
# Indirect installation
git clone https://git.brut.systems/judah/jc.jai.git
ln -s "/path/to/jc.jai" [jai install dir]/modules/jc # POSIX install
mklink /D "C:\path\to\jc.jai" [jai install dir]\jc # Windows install
#import "jc";
#import "jc/[module]";
What
----
A set of modules for things I usually want in Jai, namely,
utilities, bindings, and experiments.
How
---
If you'd like to learn more about *what* a specific module
does, take a look at its 'module.jai' file.
If you'd like to contribute, read STYLEGUIDE.
Why
---
Because Jai is still in closed beta (as of May 15, 2025),
updates to the compiler and "standard library" will break
projects of mine; sometimes in a very annoying way.
jc.jai was made to 1) give myself an escape
hatch/skin-suit to cause fewer breaking changes when
updating the compiler, and 2) put all of my non-project
code in a single place that's easier to manage.
While I do use many of the modules shipped with the
compiler, my goal is to eventually replace them.