Improve readme

This commit is contained in:
Jeremy Baxter 2023-08-10 11:02:43 +12:00
parent 716cc10392
commit 1b9db30bb8

View file

@ -46,17 +46,19 @@ support for GNU libreadline. Lua 5.4 is statically linked in.
## Installation ## Installation
> If you're using Nix, you can install the flake using Callisto is distributed as source-only, but it's not hard to compile.
> `nix profile install github:jtbx/callisto`.
Callisto is distributed as source-only, but don't worry, it's
not hard to compile.
First, get the source code using one of the tarballs found in First, get the source code using one of the tarballs found in
the [Releases](https://github.com/jtbx/callisto/releases) page. the [Releases](https://github.com/jtbx/callisto/releases) page.
Untar it then run `make` to compile Callisto. Untar it then enter the directory with Callisto's source code.
Run `make install`as the root user in the source code directory After that, run
```
make
```
to compile Callisto and all its dependencies.
To install it, run `make install` as the root user in the source code directory
to install Callisto and its shared library. to install Callisto and its shared library.
## Usage ## Usage