2019-06-19 01:10:28 +00:00
|
|
|
<h1 align="center">Welcome to 8bitworkshop 👋</h1>
|
|
|
|
<p>
|
|
|
|
<img src="https://img.shields.io/badge/version-3.4.0-blue.svg?cacheSeconds=2592000" />
|
|
|
|
<a href="http://8bitworkshop.com/">
|
|
|
|
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" target="_blank" />
|
|
|
|
</a>
|
|
|
|
<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>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
> Web-based IDE for 8-bit retro consoles like Atari 2600
|
|
|
|
>
|
|
|
|
> Ever wanted to be an old-school game programmer?
|
2019-06-19 01:14:29 +00:00
|
|
|
>
|
2019-06-19 01:10:28 +00:00
|
|
|
> Learn how classic game hardware worked.
|
2019-06-19 01:14:29 +00:00
|
|
|
>
|
2019-06-19 01:10:28 +00:00
|
|
|
> Write code and see it run instantly.
|
|
|
|
|
|
|
|
### 🏠 [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
|
|
|
|
2019-06-19 01:10:28 +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:
|
|
|
|
|
2019-06-19 01:10:28 +00:00
|
|
|
```sh
|
|
|
|
make tsweb
|
|
|
|
```
|
|
|
|
|
|
|
|
## Run tests
|
|
|
|
|
|
|
|
```sh
|
|
|
|
make test
|
|
|
|
```
|
|
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|
|
👤 **Steven Hugg**
|
|
|
|
|
|
|
|
* Github: [@sehugg](https://github.com/sehugg)
|
|
|
|
|
|
|
|
## 🤝 Contributing
|
|
|
|
|
|
|
|
Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/sehugg/8bitworkshop/issues).
|
|
|
|
|
|
|
|
## Show your support
|
|
|
|
|
|
|
|
Give a ⭐️ if this project helped you!
|
2018-12-20 18:09:32 +00:00
|
|
|
|
2019-06-19 01:10:28 +00:00
|
|
|
## 📝 License
|
2018-12-20 18:09:32 +00:00
|
|
|
|
2019-06-19 01:10:28 +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-06-19 01:10:28 +00:00
|
|
|
***
|
2019-06-19 01:14:29 +00:00
|
|
|
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
|