1
0
mirror of https://github.com/sehugg/8bitworkshop.git synced 2024-11-29 14:51:17 +00:00
8bitworkshop/README.md
2023-02-07 14:41:00 -05:00

2.8 KiB

8bitworkshop

Build Status

Use Online

Install Locally

To clone just the main branch:

git clone -b master --single-branch git@github.com:sehugg/8bitworkshop.git

To build the 8bitworkshop IDE:

git submodule init
git submodule update
npm i
npm run build

To use GitHub integration locally, download the Firebase config file, e.g. https://8bitworkshop.com/v[version]/config.js

Start Server

Start a web server on http://localhost:8000/ while TypeScript compiles in the background:

make tsweb

Run Tests

npm test

Note: Github tests may fail due to lack of API key.

License

Copyright © 2016-2022 Steven Hugg.

This project is GPL-3.0 licensed.

Dependencies retain their original licenses.

All included code samples (all files under the presets/ directory) are licensed under CC0 unless otherwise licensed.

Dependencies

The IDE uses custom forks for many of these, found at https://github.com/sehugg?tab=repositories

Emulators

Compilers

Assemblers/Linkers

Dev Kits / Libraries

Firmware