8bitworkshop/README.md

52 lines
1.3 KiB
Markdown
Raw Normal View History

<p>
<img src="https://img.shields.io/badge/version-3.4.0-blue.svg?cacheSeconds=2592000" />
<a href="https://github.com/sehugg/8bitworkshop/graphs/commit-activity">
<img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" target="_blank" />
</a>
<a href="https://github.com/sehugg/8bitworkshop/blob/master/LICENSE">
<img alt="License: GPL-3.0" src="https://img.shields.io/badge/License-GPL-3.0-yellow.svg" target="_blank" />
</a>
2019-08-21 19:33:52 +00:00
<a href="https://travis-ci.org/sehugg/8bitworkshop">
<img alt="Travis CI" src="https://travis-ci.org/sehugg/8bitworkshop.svg?branch=master" target="_blank" />
</a>
</p>
### 🏠 [Homepage](http://8bitworkshop.com/)
## Install
2018-12-20 18:09:32 +00:00
To build the 8bitworkshop IDE:
2018-07-26 15:50:20 +00:00
```sh
git submodule init
git submodule update
npm i
npm run build
```
## Usage
2018-07-26 15:50:20 +00:00
2018-12-20 18:09:32 +00:00
Start a web server on http://localhost:8000/ while TypeScript compiles in the background:
```sh
make tsweb
```
2019-08-21 19:31:20 +00:00
## Run Tests
```sh
npm test
```
## 📝 License
2018-12-20 18:09:32 +00:00
Copyright © 2019 [Steven Hugg](https://github.com/sehugg).<br />
This project is [GPL-3.0](https://github.com/sehugg/8bitworkshop/blob/master/LICENSE) licensed.
2018-12-20 18:09:32 +00:00
2019-05-20 15:38:27 +00:00
Dependencies retain their original licenses.
2019-05-23 21:59:02 +00:00
All included code samples (all files under the presets/ directory) are licensed under
[CC0](https://creativecommons.org/publicdomain/zero/1.0/)
unless otherwise licensed.
2019-05-20 15:38:27 +00:00