CoreGX Local 0.3.2
==================

CoreGX Local is the CoreGX geometry engine as a command-line program that runs
on your own machine: the same engine and language as the CoreGX API, without
a network connection or metered usage.

Language reference: https://coregx.dev/language.html


Quick start
-----------

The program goes on stdin; the result is JSON on stdout.

  Linux / macOS:
    printf 'triangle A B C\nangle A B C 90\ndistance AB 3\ndistance BC 4\n' | ./coregx svg seed=1

  Windows (PowerShell):
    "triangle A B C`nangle A B C 90`ndistance AB 3`ndistance BC 4" | .\coregx.exe svg seed=1

Run "coregx help" for all options.


License
-------

Without a license key CoreGX runs as an evaluation copy. To see which you
have:

    coregx license

If you downloaded a licensed copy, it includes a file named "key". As long as
it stays in the same folder as coregx, it is used automatically. To use
coregx from somewhere else (for example, after moving it onto your PATH),
install the key once:

  Linux / macOS:
    ./coregx install-license < key

  Windows (PowerShell):
    Get-Content key | .\coregx.exe install-license

  Windows (Command Prompt):
    coregx.exe install-license < key

The key is stored in:

  Linux     ~/.config/coregx/key  (or $XDG_CONFIG_HOME/coregx/key)
  macOS     ~/Library/Application Support/CoreGX/key
  Windows   %APPDATA%\CoreGX\key

Alternatively, set the COREGX_LICENSE environment variable to the contents
of the key file.

CoreGX looks for a key in that order: the location above, then
COREGX_LICENSE, then a "key" file next to the program.


First run
---------

Windows SmartScreen may warn about an unrecognised app: choose
"More info", then "Run anyway".


Questions: dev@saltire.com
