2 Setup
This section covers how to install xiden on your system.
2.1 Required Programs
First, make sure the following programs are available in your PATH.
SQLite 3.24.0+. Verify with sqlite3 -version
Racket 7.0+. Verify with racket -v
OpenSSL 0.9.8+. Verify with openssl version
2.2 Install from Racket’s Default Package Catalog
Xiden is available as a vanilla Racket package on the default catalog. Run raco pkg install xiden to install it, and you’re done.
If this fails and you can connect to the catalog fine, then these are the likely reasons:
Your Racket installation may contain a package that defines a conflicting xiden collection. That package can either be a different edition of Xiden, or any package snuck into your installation designed to create that conflict.
Xiden’s package tracks the latest release and is subject to backwards-incompatible changes as a matter of policy. In this case, uninstall the old version of Xiden and review the change log.
2.3 Install from Source
This method builds Xiden from your desired version of its source code.
2.3.1 Step 1: Get the Code
The goal of this step is to get a directory named xiden somewhere on your disk.
You can either use Git or download an archive.
2.3.1.1 Method: Use Git
If you wish to use Git, you can clone Xiden’s repository. If you use SSH, then run git clone git@github.com:zyrolasting/xiden.git. Or, if you use HTTPS, then run git clone https://github.com/zyrolasting/xiden.git. If you know what you are looking for, check out the commit you want to use. Otherwise, move on to Step 2.
2.3.1.2 Method: Download Archive
If you do not have Git, then you can download a ZIP file of the latest source code from the following link:
If you know what you are looking for, replace master with the commit reference you want to use. Once the archive is on your disk, extract its files.
You should have a directory named xiden with a bunch of Racket modules in it. If you have a different directory name, or if the directories are nested, then make sure to reorganize the directories accordingly.
2.3.2 Step 2: Build The Project
Enter the source directory created from Step 1. We will now build the executable and offline documentation. If you see Makefile in your current directory, then you are in the right place.
If you have GNU Make installed, then just run make. Otherwise, open Makefile and run the commands defined by the build target.
If successful, then xiden should now work as a command in your shell. If not, check your PATH to make sure that it includes the directory where raco setup creates launchers on your disk.
Alternatively, you can access the same command line interface using the raco zcpkg (“zero collection package”) command.