izaya
/
collapseos
mirror of https://github.com/hsoft/collapseos.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Mirror of CollapseOS
1,447 Commits 4 Branches 0 Tags 10 MiB
C 71.5%
Forth 19.2%
C++ 8.1%
Makefile 1%
Shell 0.2%
Go to file
Virgil Dupras c2b507eaff tools: improve usability on OpenBSD 
So far, I hadn't managed to run those tools properly on OpenBSD. I
was too confused by its stty peculiarities. I'm still confused, but
at least I managed to make them work... most of the time...
 		2020-07-02 11:36:53 -04:00
blk rc2014: separate SPI relay and SDC drivers 2020-06-29 18:48:00 -04:00
cvm cvm: remove makefile duplicate recipe 2020-06-30 10:29:06 -04:00
emul Fix makefile build-from-clean-repo glitches 2020-06-30 10:24:12 -04:00
recipes Fix makefile build-from-clean-repo glitches 2020-06-30 10:24:12 -04:00
tests tests: separate tests that need to run on z80 vs those that don't 2020-06-27 07:41:42 -04:00
tools tools: improve usability on OpenBSD 2020-07-02 11:36:53 -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 emul: build from "cvm" instead of from itself 2020-06-26 22:08:45 -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

Usage documentation is in-system, so access to documentation requires you to run Collapse OS. Fortunately, building and running Collapse OS on a POSIX environment is easy.

See /cvm/README.md for instructions.

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

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.
  • 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.