-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Write partial README and prepare Cargo.toml for publication.
- Loading branch information
1 parent
a903611
commit 5fa32ef
Showing
2 changed files
with
34 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |