Mirror of CollapseOS
Go to file
Virgil Dupras 20813f71b8 Remove discussion section from README
Having this information on the website is enough.
2020-06-24 06:27:33 -04:00
blk Add extra words WIPED? and FREEBLKS? 2020-06-23 07:21:33 -04:00
emul emul: make blk operations much faster 2020-06-22 06:29:00 -04:00
recipes z80mbc2: add BLK support 2020-06-22 21:21:24 -04:00
tests Fix tests 2020-05-14 10:58:41 -04:00
tools blkunpack: don't include trailing empty lines 2020-06-23 06:52:34 -04:00
.build.yml Replace Travis CI with Sourcehut CI 2020-06-23 20:53:38 -04:00
.gitignore Tidy up 2020-05-03 12:54:22 -04:00
.gitmodules Move "emul" folder to root 2019-12-31 13:34:24 -05:00
CONTRIBUTING.md Update CONTRIBUTING with instructions for sending patches 2020-06-23 22:11:06 -04:00
COPYING Re-license to GPLv3 2019-05-08 20:18:05 -04:00
README.md Remove discussion section from README 2020-06-24 06:27:33 -04:00
runtests.sh CI: don't needlessly run tests twice 2020-05-14 18:58:06 -04:00

Collapse OS

Bootstrap post-collapse technology

Collapse OS is a Forth operating system and a collection of tools and documentation with a single purpose: preserve the ability to program micro- controllers through civilizational collapse.

It it designed to:

  1. Run on minimal and improvised machines.
  2. Interface through improvised means (serial, keyboard, display).
  3. Edit text files.
  4. Compile assembler source files for a wide range of MCUs and CPUs.
  5. Read and write from a wide range of storage devices.
  6. Assemble itself and deploy to another machine.

Additionally, the goal of this project is to be as self-contained as possible. With a copy of this project, a capable and creative person should be able to manage to build and install Collapse OS without external resources (i.e. internet) on a machine of her design, built from scavenged parts with low-tech tools.

Getting started

Usage documentation is in-system, so access to documentation requires you to run Collapse OS. Fortunately, doing so in an emulator is easy.

See /emul/README.md for getting an emulated system running.

Then, run 0 LIST for an introduction, follow instructions from there.

Organisation of this repository

  • blk: Collapse OS filesystem's content. That's actually where Collapse OS' source code is located. Everything else is peripheral.
  • recipes: collection of recipes that assemble Collapse OS on a specific machine.
  • tools: Tools for working with Collapse OS from "modern" environments. For example, tools for facilitating data upload to a Collapse OS machine through a serial port.
  • emul: Tools for running Collapse OS in an emulated environment.
  • tests: Automated test suite for the whole project.

Status

The project unfinished but is progressing well! See Collapse OS' website for more information.

Looking for the assembler version?

The Forth-based Collapse OS is the second incarnation of the concept. The first one was entirely written in z80 assembly. If you're interested in that incarnation, checkout the z80asm branch.