Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xasopheno committed Nov 17, 2022
1 parent 7d5dd6e commit 2a32ac8
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,23 @@ A language for binaural, microtonal composition built in Rust.

<em>Make cool sounds. Impress your friends/pets/plants.</em>

**WereSoCool** is a programming language for composing microtonal music geometrically. This language doesn't require familiarity with either microtonal music or computer programming, but experience with either will certainly help.
**WereSoCool** is a cross-platform programming language for composing microtonal music geometrically. This language doesn't require familiarity with either microtonal music or computer programming, but experience with either will certainly help.

## Documentation:
If you want to learn how to make cool sounds using WereSoCool, you'll find cool documentation at [weresocool.org](https://www.weresocool.org/tutorials/welcome).
On a desktop computer, you can play with the language in a Firefox or Chrome browser.
On mobile, you can still view the tutorials, but you won't be able to hear anything.

My recommended approach to learning the language is to do the tutorials in order and write your own composition after completing each one. I'm currently working on additional documentation as well as a record I've made using WereSoCool featuring a great band. Stay tuned.

## Installation:

### From Source:
You'll need Rust and optionally Just.
You'll need cargo and optionally Just.

Rust: Rust is a great language. Install it with [Rustup](https://www.rust-lang.org/en-US/install.html).
Rust: Cargo is the rust package manager for Rust. Install cargo by installing [Rustup](https://www.rust-lang.org/en-US/install.html).

You can install from this source code by cloning this repeo and then running:
You can install from this source code by cloning this repo and then running:

1) If you have `just` installed, run `just install`
- Just is a command runner. Learn how to install just [here](https://github.com/casey/just).
Expand All @@ -31,13 +38,15 @@ Available on the AUR [here](https://aur.archlinux.org/packages/weresocool).

### Cargo:

WereSoCool can be installed on any unix system via cargo. You'll also need to install the system dependancies listed in the development section.
WereSoCool can be installed on macos, linux, and windows via cargo. You'll also need to install the system dependancies listed in the development section.

Install cargo by installing [Rustup](https://www.rust-lang.org/en-US/install.html).

`cargo install weresocool`

### Windows

This software runs on Windows, but in a slightly limited capacity. On Windows, this software is compiled without mp3 and oggvorbis support. I mostly work on unix and linux machines, so I feel a bit out of my depths in Windows land. If you'd like to help work on the Windows implementation, please reach out.
This software runs on Windows, but in a slightly limited capacity. On Windows, this software is compiled without mp3 and oggvorbis support. I mostly work on macos and linux machines, so I feel a bit out of my depths in Windows land. If you'd like to help work on the Windows implementation, please reach out.

You can install WereSoCool from source or via cargo. See above.

Expand Down

0 comments on commit 2a32ac8

Please sign in to comment.