Skip to content

Commit

Permalink
doc: improve readme (#1)
Browse files Browse the repository at this point in the history
  • Loading branch information
mkforsb authored Jan 9, 2025
1 parent 0a6e9a5 commit 8c12636
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 2 deletions.
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,50 @@
# asampo-gtk
Audio Sample Organiser (GTK frontend)
# Asampo: Audio Sample Organizer

Main features:
- Work with any number of sample sources (plain folders only at this time).
- Quickly filter/search many thousands of samples.
- Audio output runs constantly, no hiccups when previewing samples.
- Organize samples into named sets.
- Export sample set to single location, optionally with conversion.
- Load individual samples or full sets into drum machine.
- Program sequences in drum machine, save and load named sequences.
- Use drum machine to preview full sets of samples using a suitable sequence.
- Or just use the drum machine for fun!
- Saving and loading of workspaces (sources + sets + sequences).
- No destructive features, except for exporting a sample set to an existing folder.
- 🦀 Blazingly fast (maybe).

## Requirements
Asampo currently only runs on Linux using PulseAudio (runs great on `pipewire-pulse`).

## Installation
Build with `cargo` and then `cargo run`, or use a [Flatpak or AppImage](https://github.com/mkforsb/asampo-gtk/releases).

## Sources
Add, remove, and toggle sources:

![Sources pane](doc/sources.png)

## Samples
Filter, play, and assign samples to sets or a drum machine pad.

![Samples pane](doc/samples.png)

## Sets
Manage sets, assign drum pad labels, load in drum machine or export to single location:

![Sets pane](doc/sets.png)

## Sequences
Program sequences using a familiar drum machine interface:

![Sequences pane](doc/sequences.png)

# Roadmap
- [ ] Decent test coverage.
- [ ] JACK audio support.
- [ ] Windows support.
- [ ] AKAI Sample CD source type.
- [ ] Zip file / other archives source type?
- [ ] MIDI support?
- [ ] User manual.
Binary file added doc/samples.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sequences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/sources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8c12636

Please sign in to comment.