Update licensing info and some doc typos

This commit is contained in:
NGnius (Graham) 2022-07-02 16:09:58 -04:00
parent 08474a4659
commit c76562fa84
6 changed files with 10 additions and 10 deletions

View file

@ -1,6 +1,6 @@
# muss # muss
![repl_demo](https://raw.githubusercontent.com/NGnius/mps/master/extras/demo.png) ![repl_demo](https://raw.githubusercontent.com/NGnius/muss/master/extras/demo.png)
Sort, filter and analyse your music to create great playlists. Sort, filter and analyse your music to create great playlists.
This project implements the interpreter (`./interpreter`), music player (`./player`), and CLI interface for Muss (`./`). This project implements the interpreter (`./interpreter`), music player (`./player`), and CLI interface for Muss (`./`).
@ -54,7 +54,7 @@ One day I'll add pretty REPL example pictures and some script files...
LGPL-2.1-only OR GPL-3.0-only LGPL-2.1-only OR GPL-3.0-only
**NOTE**: When advanced features are enabled, GPL-3.0 must be used. **NOTE**: Advanced features make use of [a fork of bliss-rs](https://github.com/NGnius/bliss-rs) a GPL-3.0 licensed music analysis library.
## Contribution ## Contribution

View file

@ -1,6 +1,6 @@
# {{crate}} # {{crate}}
![repl_demo](https://raw.githubusercontent.com/NGnius/mps/master/extras/demo.png) ![repl_demo](https://raw.githubusercontent.com/NGnius/muss/master/extras/demo.png)
{{readme}} {{readme}}
@ -8,7 +8,7 @@
{{license}} {{license}}
**NOTE**: When advanced features are enabled, GPL-3.0 must be used. **NOTE**: Advanced features make use of [a fork of bliss-rs](https://github.com/NGnius/bliss-rs) a GPL-3.0 licensed music analysis library.
## Contribution ## Contribution

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View file

@ -170,7 +170,7 @@ Operations to sort the items in an iterable: `iterable~(sorter)` OR `iterable.so
#### field -- e.g. `iterable~(filename);` #### field -- e.g. `iterable~(filename);`
Sort by a Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end. Sort by an Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end.
#### shuffle #### shuffle
#### random shuffle -- e.g. `iterable~(shuffle);` #### random shuffle -- e.g. `iterable~(shuffle);`
@ -244,7 +244,7 @@ Various algebraic operations: brackets (order of operations), negation, subtract
#### file(filepath) -- e.g. `file("~/Music/Romantic Traffic.flac"),` #### file(filepath) -- e.g. `file("~/Music/Romantic Traffic.flac"),`
Load a item from file, populating the item with the song's tags. Load an item from file, populating the item with the song's tags.
License: LGPL-2.1-only OR GPL-3.0-only License: LGPL-2.1-only OR GPL-3.0-only

View file

@ -168,7 +168,7 @@
//! //!
//! ### field -- e.g. `iterable~(filename);` //! ### field -- e.g. `iterable~(filename);`
//! //!
//! Sort by a Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end. //! Sort by an Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end.
//! //!
//! ### shuffle //! ### shuffle
//! ### random shuffle -- e.g. `iterable~(shuffle);` //! ### random shuffle -- e.g. `iterable~(shuffle);`
@ -243,7 +243,7 @@
//! //!
//! ### file(filepath) -- e.g. `file("~/Music/Romantic Traffic.flac"),` //! ### file(filepath) -- e.g. `file("~/Music/Romantic Traffic.flac"),`
//! //!
//! Load a item from file, populating the item with the song's tags. //! Load an item from file, populating the item with the song's tags.
//! //!
mod context; mod context;

View file

@ -100,7 +100,7 @@ pub const SORTERS: &str =
Operations to sort the items in an iterable: iterable~(sorter) OR iterable.sort(sorter) Operations to sort the items in an iterable: iterable~(sorter) OR iterable.sort(sorter)
field -- e.g. iterable~(filename) field -- e.g. iterable~(filename)
Sort by a Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end. Sort by an Item field. Valid field names change depending on what information is available when the Item is populated, but usually title, artist, album, genre, track, filename are valid fields. Items with a missing/incomparable fields will be sorted to the end.
shuffle shuffle
random shuffle -- e.g. iterable~(shuffle) random shuffle -- e.g. iterable~(shuffle)
@ -160,4 +160,4 @@ Comma-separated procedure steps will be executed sequentially (like a for loop i
Format a value into a string. This behaves differently depending on the value's type: When the value is an Item, the item's corresponding field will replace all `{field}` instances in the format string. When the value is a primitive type (String, Int, Bool, etc.), the value's text equivalent will replace all `{}` instances in the format string. When the value is an iterable operation (Op), the operation's script equivalent will replace all `{}` instances in the format string. Format a value into a string. This behaves differently depending on the value's type: When the value is an Item, the item's corresponding field will replace all `{field}` instances in the format string. When the value is a primitive type (String, Int, Bool, etc.), the value's text equivalent will replace all `{}` instances in the format string. When the value is an iterable operation (Op), the operation's script equivalent will replace all `{}` instances in the format string.
file(filepath) -- e.g. file(`~/Music/Romantic Traffic.flac`) file(filepath) -- e.g. file(`~/Music/Romantic Traffic.flac`)
Load a item from file, populating the item with the song's tags."; Load an item from file, populating the item with the song's tags.";