diff --git a/README.md b/README.md index e057b0d3..cf19f5ce 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,68 @@ -# 8bitworkshop +

Welcome to 8bitworkshop 👋

+

+ + + Documentation + + + Maintenance + + + License: GPL-3.0 + +

+ +> 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 +make test +``` +## Author + +👤 **Steven Hugg** + +* Github: [@sehugg](https://github.com/sehugg) + +## 🤝 Contributing + +Contributions, issues and feature requests are welcome!
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).
+This project is [GPL-3.0](https://github.com/sehugg/8bitworkshop/blob/master/LICENSE) licensed. + +*** +_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_ \ No newline at end of file