#+TITLE: SampleHive
#+AUTHOR: Apoorv Singh
#+DESCRIPTION: A simple, modern audio sample browser/manager for GNU/Linux.

#+begin_html
<p align="center">
  <img src="assets/icons/icon-hive_256x256.png" alt="samplehive-icon" width="256" height="256">
</p>
<h1 align="center">
  SampleHive
</h1>
<p align="center">
  <h3 align="center">
    A simple, modern audio sample browser/manager for GNU/Linux.
  </h3>
  <img src="assets/logo/logo-samplehive_1920x1080.png" alt="samplehive-logo" width=890>
  <hr>
</p>
#+end_html

* Table of contents :toc:
  - [[#what-is-samplehive][What is SampleHive?]]
  - [[#dependencies][Dependencies]]
  - [[#how-to-build-samplehive][How to build SampleHive?]]
  - [[#how-to-run-samplehive][How to run SampleHive?]]
  - [[#are-there-any-keybindings-for-samplehive][Are there any keybindings for SampleHive?]]
  - [[#can-i-configure-samplehive][Can I configure SampleHive?]]

** What is SampleHive?
:PROPERTIES:
:CUSTOM_ID: what-is-samplehive
:END:
SampleHive let's you manage your audio samples in a nice and simple way, just add a directory where you store all your samples, or drag and drop a directory on it to add samples to it, and it will help sort, search, play and view some information about the sample. You can also drag and drop from SampleHive to other applications.

- Dark
#+caption: Dark Screenshot of SampleHive
#+html: <img src="assets/screenshots/screenshot-samplehive-dark.png" alt="samplehive-screenshot-dark" width=890/>

- Light
#+caption: Light Screenshot of SampleHive
#+html: <img src="assets/screenshots/screenshot-samplehive-light.png" alt="samplehive-screenshot-light" width=890/>

** Dependencies
:PROPERTIES:
:CUSTOM_ID: dependencies
:END:
On Arch based distributions,

#+begin_example
sudo pacman -S wxgtk3 wxsvg sqlite taglib yaml-cpp
#+end_example

On Debian, Ubuntu and distributions based the on two,

#+begin_example
sudo apt install libwxbase3.0-dev libwxgtk-media3.0-gtk3-dev libwxgtk3.0-gtk3-dev wx3.0-headers libwxsvg-dev libwxsvg3 libsqlite3-dev libyaml-cpp-dev libtagc0-dev libtag1-dev libtagc0 libexif-dev libpango1.0-dev
#+end_example

You might also need to install =git=, =meson= and =g++= as well, if you don't already have them installed in order to build SampleHive.

/NOTE:/ On Debian and Debian based distributions you also have to install =libwxgtk-media3.0-dev=

** How to build SampleHive?
:PROPERTIES:
:CUSTOM_ID: how-to-build-samplehive
:END:
Download the source code from this repository or use a git clone:

#+begin_example
git clone https://gitlab.com/samplehive/sample-hive
cd sample-hive
meson build -Dprefix=/tmp/SampleHive
ninja -C build install
#+end_example

This will install SampleHive under =/tmp/SampleHive=.

The configuration file will be placed under =~/.config/SampleHive/config.yaml= and the database file will be placed under =~/.local/share/SampleHive/sample.hive=

/NOTE:/ If you don't provide the =-Dprefix=/tmp/SampleHive= by default it will be installed under =/usr/local=. You can set the prefix to anything you want.

** How to run SampleHive?
:PROPERTIES:
:CUSTOM_ID: how-to-run-samplehive
:END:
To run SampleHive:

If you provided a prefix, you can go the prefix directory then go to the =bin= directory and run the SampleHive binary, for example, assuming the prefix was set to =/tmp/SampleHive=

#+begin_example
cd /tmp/SampleHive/bin
./SampleHive
#+end_example

If you didn't provide a prefix, you can find SampleHive in your menu system or run launcher and run SampleHive as you would run any other program on you system.

** Are there any keybindings for SampleHive?
:PROPERTIES:
:CUSTOM_ID: are-there-any-keybindings-for-samplehive
:END:
// TODO

** Can I configure SampleHive?
:PROPERTIES:
:CUSTOM_ID: can-i-configure-samplehive
:END:
SampleHive comes with a =config.yaml= file, that is placed under =~/.config/SampleHive/config.yaml=, that you can edit to change some settings for it.