6502/8bitworkshop
1
0
Fork 0
mirror of https://github.com/sehugg/8bitworkshop.git synced 2024-06-01 20:41:36 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #10 from haroldo-ok/improved-readme

Browse Source 
Improved readme
This commit is contained in:
Steven Hugg 2019-08-21 15:29:33 -04:00 committed by GitHub
commit 9b09cf9c4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@ -1,23 +1,70 @@
# 8bitworkshop
<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?
>
> Learn how classic game hardware worked.
>
> Write code and see it run instantly.
### 🏠 [Homepage](http://8bitworkshop.com/)
## Install
To build the 8bitworkshop IDE:
git submodule init
git submodule update
npm i
npm run build
```sh
git submodule init
git submodule update
npm i
npm run build
```
## Usage
Start a web server on http://localhost:8000/ while TypeScript compiles in the background:
make tsweb
```sh
make tsweb
```
Run all the tests:
## Run tests
make test
```sh
npm test
```
# License
## Author
The 8bitworkshop IDE is licensed under GPLv3 (see LICENSE).
👤 **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!
## 📝 License
Copyright © 2019 [Steven Hugg](https://github.com/sehugg).<br />
This project is [GPL-3.0](https://github.com/sehugg/8bitworkshop/blob/master/LICENSE) licensed.
Dependencies retain their original licenses.
@ -25,3 +72,5 @@ All included code samples (all files under the presets/ directory) are licensed
[CC0](https://creativecommons.org/publicdomain/zero/1.0/)
unless otherwise licensed.
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_