search

pandaman64 / SATySFi

A statically-typed, functional typesetting system
GNU Lesser General Public License v3.0
0 stars 0 forks source link

readme

logo1

Build Status

Summary of SATySFi

SATySFi (pronounced in the same way as the verb “satisfy” in English) is a new typesetting system with a static type system. It consists mainly of two “layers” ― the text layer and the program layer. The former is for writing documents in LaTeX-like syntax. The latter, which has ML-like syntax, is for defining functions and commands. SATySFi enables you to write documents markuped with flexible commands of your own making. In addition, its informative type error reporting will be a good help to your writing.

This software is supported by IPA Mitou Project 2017 (see the abstract here).

Install using Homebrew (for OSX users)

There is a homebrew formula for SATySFi.

$ brew install --HEAD nyuichi/satysfi/satysfi

Install using OPAM

Prerequisites

Here is a list of minimally required softwares.

Example (Ubuntu)

sudo apt-get update
sudo apt-get install build-essential git m4 unzip wget

# The following command will ask if you allow OPAM to modify some files (e.g. ~/.bash_profile).
# Be sure to read its instructions. Otherwise, some environment variables won't be set.
wget https://raw.github.com/ocaml/opam/master/shell/opam_installer.sh -O - | sh -s /usr/local/bin

opam switch 4.06.0
eval `opam config env`
opam update

Example (OS X Mavericks or later)

# Before running this scripts, install essential softwares such as GCC and Make. They can be installed from Xcode Command Line Tools.
# Also, install Homebrew.

brew update
brew install wget opam

# The following command will ask if OPAM modifies some files.
# Be sure to read their instructions. Otherwise, some environment variables won't be set.
opam init

opam switch 4.06.0
eval `opam config env`
opam update

Build

First, clone this repository and submodules. Then build SATySFi using OPAM.

# clone
git clone https://github.com/gfngfn/SATySFi.git
cd SATySFi
git submodule update --init --recursive

# Issue #46: avoid 1.0+beta18 to build core_kernel correctly.
opam pin add -y jbuilder 1.0+beta17
# build
opam pin add satysfi .
opam install satysfi

Usage of SATySFi

Type

satysfi <input files> -o <output file>

in order to convert <input files> (file names separated with spaces) into <output file>. For example, when you want to convert doc.saty into output.pdf, the following command will work:

satysfi doc.saty -o output.pdf

Command-line options