From 9fe3effa7dc5f1f8fc626db2b2d8cb4671274b80 Mon Sep 17 00:00:00 2001 From: tmtt Date: Tue, 9 Aug 2022 23:30:55 +0200 Subject: [PATCH] fix: README -> README.md (working, this time) --- README.md | 77 ++++++++++------------------------------------ README.original.md | 60 ++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 60 deletions(-) create mode 100644 README.original.md diff --git a/README.md b/README.md index 65aaf2a..633c955 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,17 @@ -[![test](https://github.com/cisco/ChezScheme/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/cisco/ChezScheme/actions/workflows/test.yml) - -Chez Scheme is both a programming language and an implementation -of that language, with supporting tools and documentation. - -As a superset of the language described in the -[Revised6 Report on the Algorithmic Language Scheme](http://www.r6rs.org) -(R6RS), Chez Scheme supports all standard features of Scheme, -including first-class procedures, proper treatment of tail calls, -continuations, user-defined records, libraries, exceptions, and -hygienic macro expansion. - -Chez Scheme also includes extensive support for interfacing with C -and other languages, support for multiple threads possibly running -on multiple cores, non-blocking I/O, and many other features. - -The Chez Scheme implementation consists of a compiler, run-time -system, and programming environment. -Although an interpreter is available, all code is compiled by -default. -Source code is compiled on-the-fly when loaded from a source file -or entered via the shell. -A source file can also be precompiled into a stored binary form and -automatically recompiled when its dependencies change. -Whether compiling on the fly or precompiling, the compiler produces -optimized machine code, with some optimization across separately -compiled library boundaries. -The compiler can also be directed to perform whole-program compilation, -which does full cross-library optimization and also reduces a -program and the libraries upon which it depends to a single binary. - -The run-time system interfaces with the operating system and supports, -among other things, binary and textual (Unicode) I/O, automatic -storage management (dynamic memory allocation and generational -garbage collection), library management, and exception handling. -By default, the compiler is included in the run-time system, allowing -programs to be generated and compiled at run time, and storage for -dynamically compiled code, just like any other dynamically allocated -storage, is automatically reclaimed by the garbage collector. - -The programming environment includes a source-level debugger, a -mechanism for producing HTML displays of profile counts and program -"hot spots" when profiling is enabled during compilation, tools for -inspecting memory usage, and an interactive shell interface (the -expression editor, or "expeditor" for short) that supports multi-line -expression editing. - -The R6RS core of the Chez Scheme language is described in -[The Scheme Programming Language](http://www.scheme.com/tspl4/), -which also includes an introduction to Scheme and a set of example programs. -Chez Scheme's additional language, run-time system, and -programming environment features are described in the -[Chez Scheme User's Guide](http://cisco.github.io/ChezScheme/csug9.5/csug.html). -The latter includes a shared index and a shared summary of forms, -with links where appropriate to the former, so it is often the best -starting point. - -Get started with Chez Scheme by [Building Chez Scheme](BUILDING). - -For more information see the [Chez Scheme Project Page](https://cisco.github.io/ChezScheme/). +# chez-openbsd - mirror of ChezScheme with OpenBSD boot files +## ChezScheme v9.5.9 + +**THIS REPO IS A MIRROR OF [CHEZSCHEME](https://github.com/cisco/ChezScheme) CONTAINING OPENBSD BOOT FILES.** +I am not the owner of ChezScheme nor a developer of ChezScheme. +Please send issues related to ChezScheme directly to their [Github repo](https://github.com/cisco/ChezScheme). +You'll find a copy of the original README in `README.original.md`. + +To build on OpenBSD, simply do: +```bash +$ ./configure --threads +$ gmake -jN +``` +`--threads` enables (posix) thread support and the `N` in `-jN` being the number of cores in your system. + +See [releases](https://basedwa.re/tmtt/chez-openbsd/releases). +See [the original blogpost](https://heimdall.pm/blog/2022/07/28/how-to-build-chezscheme-on-openbsd.html) for more information. diff --git a/README.original.md b/README.original.md new file mode 100644 index 0000000..65aaf2a --- /dev/null +++ b/README.original.md @@ -0,0 +1,60 @@ +[![test](https://github.com/cisco/ChezScheme/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/cisco/ChezScheme/actions/workflows/test.yml) + +Chez Scheme is both a programming language and an implementation +of that language, with supporting tools and documentation. + +As a superset of the language described in the +[Revised6 Report on the Algorithmic Language Scheme](http://www.r6rs.org) +(R6RS), Chez Scheme supports all standard features of Scheme, +including first-class procedures, proper treatment of tail calls, +continuations, user-defined records, libraries, exceptions, and +hygienic macro expansion. + +Chez Scheme also includes extensive support for interfacing with C +and other languages, support for multiple threads possibly running +on multiple cores, non-blocking I/O, and many other features. + +The Chez Scheme implementation consists of a compiler, run-time +system, and programming environment. +Although an interpreter is available, all code is compiled by +default. +Source code is compiled on-the-fly when loaded from a source file +or entered via the shell. +A source file can also be precompiled into a stored binary form and +automatically recompiled when its dependencies change. +Whether compiling on the fly or precompiling, the compiler produces +optimized machine code, with some optimization across separately +compiled library boundaries. +The compiler can also be directed to perform whole-program compilation, +which does full cross-library optimization and also reduces a +program and the libraries upon which it depends to a single binary. + +The run-time system interfaces with the operating system and supports, +among other things, binary and textual (Unicode) I/O, automatic +storage management (dynamic memory allocation and generational +garbage collection), library management, and exception handling. +By default, the compiler is included in the run-time system, allowing +programs to be generated and compiled at run time, and storage for +dynamically compiled code, just like any other dynamically allocated +storage, is automatically reclaimed by the garbage collector. + +The programming environment includes a source-level debugger, a +mechanism for producing HTML displays of profile counts and program +"hot spots" when profiling is enabled during compilation, tools for +inspecting memory usage, and an interactive shell interface (the +expression editor, or "expeditor" for short) that supports multi-line +expression editing. + +The R6RS core of the Chez Scheme language is described in +[The Scheme Programming Language](http://www.scheme.com/tspl4/), +which also includes an introduction to Scheme and a set of example programs. +Chez Scheme's additional language, run-time system, and +programming environment features are described in the +[Chez Scheme User's Guide](http://cisco.github.io/ChezScheme/csug9.5/csug.html). +The latter includes a shared index and a shared summary of forms, +with links where appropriate to the former, so it is often the best +starting point. + +Get started with Chez Scheme by [Building Chez Scheme](BUILDING). + +For more information see the [Chez Scheme Project Page](https://cisco.github.io/ChezScheme/).