Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/Sintrastes/hsfret
Browse files Browse the repository at this point in the history
  • Loading branch information
Sintrastes committed Jun 2, 2022
2 parents 979d576 + 5545d84 commit 80e2d72
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Xen fret
# Xen Fret

<p align="center">
<a href="https://haskell.org/">
Expand All @@ -9,12 +9,31 @@
</a>
</p>

Xen fret is a simple web app for generating SVG xenharmonic/microtonal scale diagrams for fretted string instruments. Specifically, for generating scale diagrams for equal temperaments.
Xen Fret is a simple web app for generating SVG xenharmonic/microtonal scale diagrams for fretted string instruments. Specifically, for generating scale diagrams for equal temperaments.

Gettring started
----------------

Xen fret is built with [reflex-frp](https://reflex-frp.org/) and [nix](https://github.com/NixOS/nix), and can be deployed as a static webpage (with front-end Javascript). An example of this is currently hosted at...
Xen Fret is currently hosted [here](https://sintrastes.github.io/demos/xen_fret/) as a static page on github pages. In the future, we may add desktop and mobile versions.

Building
--------

Xen Fret is built with [reflex-frp](https://reflex-frp.org/) and [nix](https://github.com/NixOS/nix), and can be deployed as a static webpage (with front-end Javascript). To build a static front-end with nix, simply run `nix-build -A ghcjs.frontend`.

Xen fret can also be built as a native executable thanks to [jsaddle](https://github.com/ghcjs/jsaddle). To build Xen Fret this way, simply run:

```
nix-build -A ghc.frontend
```

to build with nix, or

```
cabal build frontend
```

to build with [cabal](https://www.haskell.org/cabal/).

Example Screenshots
-------------------
Expand Down

0 comments on commit 80e2d72

Please sign in to comment.