izaya/collapseos
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Mirror of CollapseOS
1,494 Commits 4 Branches 0 Tags 13 MiB
C 79.6%
Forth 19.2%
Makefile 1%
Shell 0.2%
6d2a0f749a
Go to file
Virgil Dupras 6d2a0f749a recipes/rc2014: fix out-of-date information
2020-08-16 20:54:06 -04:00
blk Move SD Card subsystem outside of RC2014 recipe and add protocols 2020-08-16 14:30:33 -04:00
cvm doc: take dictionary out of blkfs 2020-08-16 08:22:41 -04:00
doc Move SD Card subsystem outside of RC2014 recipe and add protocols 2020-08-16 14:30:33 -04:00
emul Replace "-ansi" with "-std=c89" in emul/Makefile 2020-07-23 20:10:30 -04:00
recipes recipes/rc2014: fix out-of-date information 2020-08-16 20:54:06 -04:00
tests Fix SDC tests 2020-07-05 15:01:59 -04:00
tools tools: improve stty-related advices in README 2020-08-02 16:21:31 -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
README.md doc: move usage documention out of the system 2020-08-15 19:40:36 -04:00
runtests.sh tests: separate tests that need to run on z80 vs those that don't 2020-06-27 07:41:42 -04:00

README.md

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

Documentation is in text files in doc/. Begin with intro.txt.

Collapse OS can run on any POSIX platform and builds easily. See /cvm/README.md for instructions.

Alternatively, there's also Michael Schierl's JS Collapse OS emulator which is awesome and allows you to run Collapse OS from your browser, but it isn't always up to date. The "Javascript Forth" version is especially awesome: it's not a z80 emulator, but a javascript port of Collapse OS!

Organisation of this repository

  • blk: Collapse OS filesystem's content. That's actually where Collapse OS' source code is located. Everything else is peripheral.
  • cvm: A C implementation of Collapse OS, allowing it to run natively on any POSIX platform.
  • doc: Documentation.
  • 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.