Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
inthar-raven committed Aug 10, 2024
1 parent c59d963 commit 826a057
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
This is a microtonal scale research app chiefly dedicated to ternary scales (scales with three distinct step sizes). It focuses on [aberrismic theory](https://en.xen.wiki/w=Aberrismic_theory), developed by groundfault, inthar, and others.
This is a microtonal scale research app chiefly dedicated to ternary scales (scales with three distinct step sizes). It focuses on [aberrismic theory](https://en.xen.wiki/w/Aberrismic_theory), developed by groundfault, inthar, and others.

# How to build and run:
On Linux, install the Rust toolchain and run `cargo run --release` in this directory. You should see a link. Ctrl-click on it to go to the main page.
On Linux, install the Rust toolchain and run `cargo run --release` in the project directory. You should see a link `http://127.0 0.1:8080/static/index.html`. Ctrl-click on it to go to the main page.

Windows is not supported at this time.
This program may not work in Windows systems at this time.

# Completed features:
* Get the set of all scales (up to mode) with a certain step signature.
Expand All @@ -21,7 +21,3 @@ Windows is not supported at this time.
* * guide frame complexity
* * monotone MOS properties
* * maximum variety

# Planned features:
* Support non-octave equaves
* Remove the need for a server timeout by migrating computational logic to client side, possibly using Rust+WASM

0 comments on commit 826a057

Please sign in to comment.