From 850d8b4ead7c6c532430f9fcb0e422908d10e5d4 Mon Sep 17 00:00:00 2001 From: Anthony Foxclaw <35226681+tonytins@users.noreply.github.com> Date: Thu, 6 Feb 2020 20:39:19 -0500 Subject: [PATCH] Rereorganized README for docs --- README.md | 10 ++++++++-- docs/README.md | 23 +++++++++++++++++++++++ 2 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/README.md diff --git a/README.md b/README.md index 677bd99..336cbbe 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..d38a4c8 --- /dev/null +++ b/docs/README.md @@ -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. \ No newline at end of file