diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..0ef7710 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# Firmware for the Southern Star Mk II + +This repository contains the firmware for the Southern Star Mk II. A wearable +computer built using a Z80 microprocessor. + +The code here is *really* early in development. It consists mostly code of code +fragments from other prototypes held together by duct tape. Almost nothing of +the architecture and capabilities of the operating system has been decided. + +The firmware includes a modified version of the +[zbootloader](https://git.thomaslabs.org/zbootloader/) for uploading programs +over the serial port. (see [zup](https://git.thomaslabs.org/zup/), the upload +utility) + +## What is missing? + +The question should be, what is not missing? Nonetheless: +- Documentation on the hardware and software architecture +- Tests for the bootloader +- Update ROM contents over USB +- scheme interpreter and compiler +- multitasking (if doable in such a restricted environment) +- Filesystem support + +## File structure +- asm: Assembly code +- doc: Documentation (not ready yet) +- include: header files for both C and Assembly +- src: C source code +- manifest.scm: Guix packages for compiling the firmware image + +## Related repositories +[Computer schematics](https://git.thomaslabs.org/southern-star-mk2/hardware/) +[3D Model of the enclosure](https://git.thomaslabs.org/southern-star-mk2/3d/) + +## Acknowledgements +- SDCC developers; Big part of asm/crt0.asm is taken from the defualt crt0 file |