Mirror of CollapseOS
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Virgil Dupras ea41acec5c Move to Sourcehut 4 months ago
blk Add extra words WIPED? and FREEBLKS? 4 months ago
emul emul: make blk operations much faster 4 months ago
recipes z80mbc2: add BLK support 4 months ago
tests Fix tests 5 months ago
tools blkunpack: don't include trailing empty lines 4 months ago
.build.yml Replace Travis CI with Sourcehut CI 4 months ago
.gitignore Tidy up 6 months ago
.gitmodules Move "emul" folder to root 10 months ago
CONTRIBUTING.md CONTRIBUTING: add note about typo PRs 4 months ago
COPYING Re-license to GPLv3 1 year ago
README.md Move to Sourcehut 4 months ago
runtests.sh CI: don't needlessly run tests twice 5 months ago

README.md

Collapse OS

Moved to Sourcehut

The project has been moved to https://sr.ht/~vdupras/collapseos/. See issue #127 for details.

If it hasn't been already, this repo will end up being put in Archived mode. Some issues opened on Github open very interesting discussions. Do not hesitate to begin a thread referring to a Github issue on the mailing list associated to the project on Sourcehut.

Until the project is archived, know that any PR opened here will be ignored. Please submit a patch on the mailing list.

Presentation

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.

Discussion

For a general discussion of Collapse OS and the ecosystem of technologies and ideas that may develop around it refer to r/collapseos

I also stick around on IRC (#collapseos on freenode).