Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.39 KB

README.md

File metadata and controls

54 lines (41 loc) · 2.39 KB

A scie lift

GitHub Github Actions CI Discord

Delivers science, a high level tool to build scies with.

The science tool is intended to be the primary tool used by applications to build scies. Although the scie-jump provides everything needed to build a scie, it is low-level and will always have some sharp corners, including its JSON lift manifest format.

The science binary is itself a scie built with science using the application manifest at lift.toml.

Installing

You'll need to download the correct binary for your system, mark it as executable and place it on your $PATH somewhere.

The binaries are released via GitHub Releases for Windows, Linux and macOS for both aarch64 and x86-64. For each of these platforms there are two varieties, "thin" and "fat". The "fat" varieties are named science-fat-*, include a hermetic CPython 3.12 distribution from the Python Build Standalone project and are larger as a result. The "thin" varieties have the CPython 3.12 distribution gouged out and are smaller as a result. In its place a ptex binary is included that fills in the CPython 3.12 distribution by fetching it when the "thin" science binary is first run.

You can install the latest science "fat" binary release using a convenience install script like so:

  • Linux and macOS:
    $ curl --proto '=https' --tlsv1.2 -LSsf https://raw.githubusercontent.com/a-scie/lift/main/install.sh | bash
    ...
    $ science -V
    
  • Windows PowerShell:
    > irm https://raw.githubusercontent.com/a-scie/lift/main/install.ps1 | iex
    ...
    > science -V
    

The high level documentation is currently thin! The command line help is pretty decent though; so try there 1st starting with just running science with no arguments.

If you'd like to build you own version, see the contribution guide. There are build instructions there.

Contribute

See the contribution guide if you're interested in hacking on science or improving its documentation.