Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xaviergodart committed Mar 5, 2023
1 parent e56b705 commit 22f60cf
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Sektron

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/xaviergodart/sektron) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/xaviergodart/sektron/build.yml)

Sektron is a midi step sequencer, made with live performance in mind, that runs in the terminal (TUI).
Its main purpose is to mimic the fun and immediacity of hardware sequencers by being entirely controllable via keyboard.

Expand All @@ -9,9 +11,19 @@ It's heavily inspired by [elektron devices](https://www.elektron.se).

![sektron screenshot](/docs/screenshot.png)


## Installation

[Download the last release](https://github.com/xaviergodart/sektron/releases) for your platform.

Then:
```sh
# Extract files
mkdir -p sektron && tar -zxvf sektron_VERSION_PLATFORM.tar.gz -C sektron

# Run sektron
./sektron
```

### Build it yourself

Expand All @@ -29,16 +41,10 @@ make GOLANG_OS=darwin build
make GOLANG_OS=windows build
```

Then:
```sh
./bin/sektron
```


## Usage

```sh
./bin/sektron
./sektron
```

Hit `?` to see all keybindings. `esc` to quit.
Expand All @@ -47,6 +53,7 @@ Hit `?` to see all keybindings. `esc` to quit.

[Qsynth](https://qsynth.sourceforge.io/) is a nice companion app for testing Sektron.


### Keyboard mapping

Keys mapping is fully customizable. After running Sektron for the first time, a `config.json` is created.
Expand All @@ -59,24 +66,24 @@ The default key mapping looks like this:
You can select one of the fex default keyboard layouts are available:
```sh
# QWERTY
./bin/sektron --keyboard qwerty
./sektron --keyboard qwerty

# AZERTY
./bin/sektron --keyboard azerty
./sektron --keyboard azerty

# QWERTY MAC
./bin/sektron --keyboard qwerty-mac
./sektron --keyboard qwerty-mac

# AZERTY MAC
./bin/sektron --keyboard azerty-mac
./sektron --keyboard azerty-mac
```

### Patterns management

Each time you start Sektron, a json file (default: `patterns.json`) containing 128 pattern slots is loaded.
For selecting a different file, use the `--patterns` flag:
```sh
./bin/sektron --patterns my-patterns.json
./sektron --patterns my-patterns.json
```

## Acknowledgments
Expand All @@ -86,6 +93,7 @@ Sektron uses a few awesome packages:
- [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea) as the main TUI framework
- [charmbracelet/lipgloss](https://github.com/charmbracelet/lipgloss) for making things beautiful


## Roadmap for 0.1

- [x] Exhaustive midi messages type (CC etc...)
Expand All @@ -94,6 +102,7 @@ Sektron uses a few awesome packages:
- [ ] Improve controls UX
- [ ] Write documentation


## Roadmap for later

- Step polyphony
Expand Down

0 comments on commit 22f60cf

Please sign in to comment.