1  # athenaCL
 2  
 3  athenaCL is an algorithmic composition tool created by Christopher Ariza.
 4  
 5  Or, as described by the author more specifically, it is a tool for:
 6  > modular poly-paradigm algorithmic music composition in a cross-platform
 7  > interactive command-line environment.
 8  
 9  
10  
11  
12  ## Documentation
13  
14  The manual is built using [mdBook](https://rust-lang.github.io/mdBook) you will
15  find the source code inside `doc/` directory. You can read it 
16  [here](https://alestsurko.by/athenaCL/).
17  
18  
19  
20  
21  ## Usage
22  
23  You don't need python. To run this program, just:
24  
25  ```
26  $ cargo run --release
27  ```
28  
29  `cargo test` will run not only rust tests, but python tests as well.
30  
31  
32  
33  
34  ## About This Fork
35  
36  Initially this repo was forked to update the code to python3. But then I
37  considered to build a GUI version of **athenaCL**. Today the code is adapted for
38  GUI needs:
39  
40  - it's modified to be easily embeddable into binary (using **RustPython** and
41    freezing);
42  - some features related to CLI are removed, to make it work better with
43    **RustPython**;
44  - while the CLI version might still work, it's not supported, so expect bugs.
45  
46  If you're interested in the original (CLI) version, check out the
47  [`pregui`](https://github.com/ales-tsurko/athenaCL/releases/tag/pregui) tag.