![Interim OS Bomberjacket Logo](http://dump.mntmn.com/bjos.png)

Interim
-------

Interim OS is a radical new operating system with a focus on minimalism. It steals conceptually from Lisp machines (language-based kernel) and Plan 9 (everything is a file system). It boots to a JITting Lisp-like REPL and offers the programmer/user the system's resources as filesystems.

Interim runs on:
- Raspberry Pi 2 (Broadcom VideoCore4/ARMv7, Bare Metal)
- ARM5+ Linux (Hosted)
- Intel/AMD x64 Linux, Mac OS X (Hosted)
- Intel/AMD x86 Linux, Windows (Hosted, win32 .exe cross compiled from Linux)
- Motorola 68020+ Amiga OS 3.x+ (Hosted)

Detailed docs are in *docs/index.html*.

Contact / FAQ / Get Involved
----------------------------

The official IRC channel for development and usage questions is #interim-os on freenode.

If you find bugs, please file an issue in the [Github issue tracker](https://github.com/mntmn/interim/issues).

Architecture
------------

- Layer 2: Bitmapped Terminal / Editor
- Layer 1: Sledge Lisp JIT Compiler
- Layer 0: Platform Interface (Startup code and filesystems)

Design Choices
--------------

- The shell is the editor is the REPL is the language is the compiler.
- Namespacing allows sandboxing and network transparency.
- You need only one text encoding: UTF-8.
- All facilities must be navigable by keyboard.

Building
--------

1. Get the dependencies. For a (Linux-)hosted version, this is only GCC and SDL1 or SDL2 if you want windowed graphics. Sledge can also use /dev/fb0 instead if available on your platform. If you want to cross-compile for an ARM platform, get *arm-none-eabi-gcc* and *libnewlib-arm-none-eabi*.

1b. For a hosted version on Mac OS X, you will need GNU binutils, which can be obtained via homebrew: ````brew install binutils````. You can also get SDL2 via homebrew.

2. To build the hosted variant, cd to ````sledge```` and ````./build_x64.sh````.

2b. To build the hosted variant on ARM, cd to ````sledge```` and ````./build_arm.sh````.

3. To cross-compile for bare metal, use ````./rpi2-build.sh````. This will create build/interim-arm.elf.

Running (Hosted)
----------------

    cd sledge
    ./sledge

To launch the graphical REPL/Shell:

    ./sledge boot-os.l

Running (Raspberry Pi 2)
------------------------

Prepare a bootable SD card with the usual FAT partition that has the Pi-specific boot blobs in it and copy ````kernel.img```` into it. You can recycle any other Raspberry OS distribution, i.e. Raspian for this. Just replace the kernel7.img and delete cmdline.txt. Keyboard input is currently only over UART, so you will probably want to connect a UART->USB cable to another computer and use it to control Interim. 

![Interim OS Screenshot](http://dump.mntmn.com/interim-paper/illustrations/interim-picture.jpg?wat=1)

Roadmap
-------

- IEEE 754 double-precision floating point numbers.
- Vectors.
- Native string maps (dictionaries) based on the existing sd_hash.
- JavaScript to Interim Lisp compiler.

Licenses
--------

Interim OS: GNU GPLv3 or later, (C) 2015-2018 Lukas F. Hartmann / @mntmn

Interim OS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

- newlib: GNU GPLv2, Maintained by Corinna Vinschen, Jeff Johnston / Red Hat Inc.
- devices/rpi2/uspi: GNU GPLv3, Copyright (C) 2014-2015  R. Stange <rsta2@o2online.de>
- devices/rpi2/rpi-boot: Copyright (C) 2013 by John Cronin <jncronin@tysos.org>
- devices/rpi2/mmu.c for Raspberry Pi 2 adapted from code Copyright (C) 2015 by Goswin von Brederlow, GNU GPLv3+
- devices/rpi2/fat FAT file system module Copyright by (C) 2013 by ChaN, Free Software / Custom License
- GNU Unifont: GNU GPLv2+, originally by Roman Czyborra
- devices/imx233 IMX233 Port contains code from U-Boot, GPLv2+, written by various engineers. See license headers in source files.

Codecs

- minimp3: GNU LGPL, Copyright (C) 2001, 2002 Fabrice Bellard, (C) 2007 Martin J. Fiedler
- uPNG: zlib License, Copyright (C) 2005-2010 Lode Vandevenne, (C) 2010 Sean Middleditch
- NanoJPEG: KeyJ's Research License, Copyright (C) 2014 Martin J. Fiedler
