Skip to content

Commit

Permalink
Write partial README and prepare Cargo.toml for publication.
Browse files Browse the repository at this point in the history
  • Loading branch information
CrashAndSideburns committed Jul 25, 2023
1 parent a903611 commit 5fa32ef
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name = "ruxn"
version = "0.1.0"
authors = ["Morgan Arnold <morgan.arnold@proton.me>"]
edition = "2021"
description = "An implementation of the Uxn virtual machine written in Rust."
repository = "https://github.com/CrashAndSideburns/ruxn"
description = "An implementation of the Uxn stack-machine written in Rust."
categories = ["emulators"]
keywords = ["uxn", "varvara"]
repository = "https://git.sr.ht/~mra/ruxn"
license = "Unlicense"

[dependencies]
edition = "2021"
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# ruxn

[![Crates.io](https://img.shields.io/crates/v/ruxn?style=flat-square&logo=rust)](https://crates.io/crates/ruxn)
[![Crates.io](https://img.shields.io/crates/l/ruxn?style=flat-square)](./UNLICENSE)

ruxn is an emulator for [the Uxn stack-machine](https://100r.co/site/uxn.html), designed to make the creation and emulation of Uxn-based computers simple and fun.

# Installation

Either run
```
cargo add ruxn
```
or modify your `Cargo.toml`
```
ruxn = "0.1.0"
```

# Usage

<!-- TODO: Write usage section later, once user-facing API is more completely-defined. -->

# Contributing

Contributrions are welcome! Please open an issue or submit a pull request.

# License

This is free and unencumbered software released into the public domain. See the [UNLICENSE](./UNLICENSE) file or [unlicense.org](https://unlicense.org/) for details.

0 comments on commit 5fa32ef

Please sign in to comment.