Rereorganized README for docs

This commit is contained in:
Anthony Foxclaw 2020-02-06 20:39:19 -05:00
parent c1bdbc78c5
commit 850d8b4ead
2 changed files with 31 additions and 2 deletions

View file

@ -1,8 +1,14 @@
# Corten
![Rust](https://github.com/tonytins/corten/workflows/Rust/badge.svg) [![Build Status](https://travis-ci.org/tonytins/corten.svg?branch=master)](https://travis-ci.org/tonytins/corten) [![Build status](https://ci.appveyor.com/api/projects/status/ffru6ik26j2b87ko?svg=true)](https://ci.appveyor.com/project/tonytins/corten) [![codecov](https://codecov.io/gh/tonytins/corten/branch/master/graph/badge.svg)](https://codecov.io/gh/tonytins/corten)
Corten is a stack-based virtual machine written in Rust as a hobby. It's based on the [Iridium 1](spec.md#Iridium) architecture from Fletcher Haynes's [So you want to build a language VM](https://blog.subnetzero.io/post/building-language-vm-part-01/).
Corten is a stack-based virtual machine written in Rust.
## Build Status
| Service | Status |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Github | ![Rust](https://github.com/tonytins/corten/workflows/Rust/badge.svg) |
| Travis CI | [![Build Status](https://travis-ci.org/tonytins/corten.svg?branch=master)](https://travis-ci.org/tonytins/corten) |
| AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/ffru6ik26j2b87ko?svg=true)](https://ci.appveyor.com/project/tonytins/corten) |
## Specifications

23
docs/README.md Normal file
View file

@ -0,0 +1,23 @@
# Corten
Corten is a stack-based virtual machine written in Rust as a hobby. It's based on the [Iridium 1](spec.md#Iridium) architecture from Fletcher Haynes's [So you want to build a language VM](https://blog.subnetzero.io/post/building-language-vm-part-01/).
## Build Status
| Service | Status |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Github | ![Rust](https://github.com/tonytins/corten/workflows/Rust/badge.svg) |
| Travis CI | [![Build Status](https://travis-ci.org/tonytins/corten.svg?branch=master)](https://travis-ci.org/tonytins/corten) |
| AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/ffru6ik26j2b87ko?svg=true)](https://ci.appveyor.com/project/tonytins/corten) |
## Requirements
### Supported Platforms
- Ubuntu 18.04+
- Windows 10 v1809+
- macOS 10.15+
## License
This project is licensed under the MPL 2.0 license - see the [LICENSE](LICENSE) file for details.