izaya/collapseos
1
0
Fork 0
mirror of https://github.com/hsoft/collapseos.git synced 2024-11-23 12:38:05 +11:00
Code Issues Releases Wiki Activity
Mirror of CollapseOS
1,620 Commits 4 Branches 0 Tags 10 MiB
C 71.5%
Forth 19.2%
C++ 8.1%
Makefile 1%
Shell 0.2%
95ab1ad588
Go to file
Virgil Dupras 95ab1ad588 Transform "blk/" folders into "blk.fs" text files 
Working in "blk/" folder from a modern system is harder than it
should be. Moving blocks around is a bit awkward, grepping is a
bit less convenient than it could be, git blame has troubles
following, etc.

In this commit, we modify blkpack and blkunpack to work with single
text files with blocks being separated by a special markup.

I think this will make the code significantly more convenient to
work into.
2020-11-14 18:34:15 -05:00
arch Transform "blk/" folders into "blk.fs" text files 2020-11-14 18:34:15 -05:00
cvm Transform "blk/" folders into "blk.fs" text files 2020-11-14 18:34:15 -05:00
doc doc: improve "hook word" description 2020-11-14 14:34:01 -05:00
emul sms: add support for VDP's text mode 2020-11-13 12:18:00 -05:00
tests Add word ROT> 2020-10-29 12:41:08 -04:00
tools Transform "blk/" folders into "blk.fs" text files 2020-11-14 18:34:15 -05:00
.build.yml Replace Travis CI with Sourcehut CI 2020-06-23 20:53:38 -04:00
.gitignore recipes/ti84: move recipe blocks into local overlay 2020-09-20 20:24:09 -04:00
blk.fs Transform "blk/" folders into "blk.fs" text files 2020-11-14 18:34:15 -05:00
CONTRIBUTING.md Complete overhaul of recipes 2020-10-30 20:39:39 -04:00
COPYING Re-license to GPLv3 2019-05-08 20:18:05 -04:00
README.md Transform "blk/" folders into "blk.fs" text files 2020-11-14 18:34:15 -05:00
runtests.sh cvm: split stage and forth xcomp units 2020-11-14 15:00:03 -05: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.fs: Collapse OS filesystem's content. See below.
  • cvm: A C implementation of Collapse OS, allowing it to run natively on any POSIX platform.
  • doc: Documentation.
  • arch: collection of makefiles that assemble Collapse OS on different machines.
  • 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.

blk.fs

This file is a big text file containing the "real deal", that is, the contents of Collapse OS' filesystem. That filesystem contains everything that a post-collapse computer would manage, that is, all Forth and assembler source code for the tools it needs to fulfill its goals.

The Collapse OS filesystem is a simple sequence of 1024 bytes blocks. That is not very workable in the text editor of a modern system. blk.fs represents an "unpacked" view of that block system. Each block (16 lines max per block, 64 chars max per line) begins with a marker indicating the block number of the contents that follow.

Blocks must be in ascending order.

That file can be "packed" to a real blkfs with /tools/blkpack. A real blkfs can be "unpacked" to its text file form with /tools/blkunpack.

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.