mirror of
https://github.com/sehugg/8bitworkshop.git
synced 2024-12-09 04:49:54 +00:00
Improved README
Created a new, more detailed, README file with the help of 'readme-md-generator'.
This commit is contained in:
parent
10f89d0c53
commit
ebd7aa33e8
67
README.md
67
README.md
@ -1,17 +1,68 @@
|
||||
# 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
|
||||
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!
|
||||
|
||||
## 📝 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.
|
||||
|
||||
***
|
||||
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
|
Loading…
Reference in New Issue
Block a user