github.com/Interlisp.maiko
1
0
Fork 0
mirror of https://github.com/Interlisp/maiko.git synced 2026-01-16 16:19:10 +00:00
Code Issues Projects Releases Wiki Activity

move Build instructions to wiki (#259)

Browse Source 
* move Build instructions to wiki

* added too many links, fixed

* put (new) build instructions

* More tweaks to text
This commit is contained in:
Larry Masinter 2021-01-22 11:29:53 -08:00 committed by GitHub
parent 13370475d4
commit 1b1ff995c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -1,30 +1,49 @@
# Maiko
This is the implementation of the Medley Interlisp virtual machine, for a
Maiko is the implementation of the Medley Interlisp virtual machine, for a
byte-coded Lisp instruction set and some low-level functions for
connecting with Lisp for access to display and disk etc.
See [the main Medley repository](https://github.org/Interlisp/medley) for
Issues, Discussions, documents and more context.)
connecting with Lisp for access to display (via X11) and disk etc.
There are make file fragments that include all the flags and
variables you have to set for each hardware/OS target.
Newcomers should check out the [Medley Interlisp Introduction](https://github.com/Interlisp/medley/wiki/Medley-Interlisp-Introduction).
- cd to the "bin" directory
- do `./makeright x`
See [the Medley repository](https://github.org/Interlisp/medley) for
* [Issues](https://github.com/Interlisp/medley/issues) (note that maiko issues are there too)
* [Discussions](https://github.com/Interlisp/medley/discussions) (Q&A, announcements, etc)
* [Medley's README](https://github.com/Interlisp/medley/blob/master/README.md)
It will (attempt to) detect the OS-type and cpu-type, and put
together the makefile parts that it needs.
It will build in ../ostype.cputype-x (for the .o files) and
../ostype.cputype for the executables.
Bug reports, feature requests, fixes and improvements, support for additional platforms and hardware are all welcome.
## Development Platforms
## ## Development Platforms
We are developing on FreeBSD, Linux, macOS, and Solaris currently
on arm, arm64, PowerPC, SPARC, x86, and x86_64 hardware.
We are developing on FreeBSD, Linux, MacOS, and Solaris currently
on arm7l, arm64, PowerPC, SPARC, i386, and x86_64 hardware.
We believe it will work on these platforms.
Fixes and improvements for additional platforms and hardware is
welcome. Work is underway to run better on Windows.
## Building Maiko
Building requires `clang`, `make`, X11 client libraries (`libx11-dev`). For example,
``` sh
$ sudo apt update
$ sudo apt install clang make x11dev
```
```
$ cd maiko/bin
$ ./makeright x
```
* The build will (attempt to) detect the OS-type and cpu-type. It will build binaries `lde` and `ldex` in `../ostype.cputype` (with .o files in `..ostype.cputype-x`. For example, Linux on a 64-bit x86 will use `linux.x86_64`, while MacOS 11 on (new) Mac will use `darwin.arm64`.
* If you prefer using `gcc` over `clang`, you will need to edit the makefile fragment for your configuration (`makefile-ostype.cputype-x1) and comment out the line (with a #) that defines `CC` for `clang` and uncomment the line (delete the #) for the line that defines `CC` for `gcc`.
* There is a cmake configuration (TBD)
### Building For MacOS
* Running on MacOS requires an X server, and building on a Mac requires X client libraries.
An X-server for x86 MacOS (and X11 client libraries) can be freely obtained at https://www.xquartz.org/
For the new arm64 MacOS 11, you'll need https://x.org which you can get via MacPorts or Brew.
### Building for Windows 10
Windows 10 currently requires "Docker for Desktop" or WSL2 -- basically a Linux virtual machine -- and and a (Windows X-server).
See [Medley's README](https://github.com/Interlisp/medley/blob/master/README.md) for more.
In the past, Maiko ran on DOS. This may or may not still work.