diff --git a/content/docs/building-from-source.org b/content/docs/building-from-source.org index ad5b4f9..ca01bbd 100644 --- a/content/docs/building-from-source.org +++ b/content/docs/building-from-source.org @@ -12,16 +12,16 @@ Chordcat depends on the following libraries: CMake will fetch and build some of these dependencies from source while building chordcat. See the next section for installation of the -required dependencies of above libraries. +required dependencies. ** Prerequisites Firstly, you will need CMake and a modern C++ compiler that supports C++20 (gcc, clang, etc.) -In order for CMake to be able to build the above libraries, you will -need to install the dependencies for each of those libraries. This -varies from platform to platform so please visit the respective -project pages to find out the dependencies for your platform. +In order for CMake to be able to build chordcat, you will need +to install these libraries on your system. Libraries which are +not commonly available on most systems (like ImGui and ImGui-SFML) +will be fetched and built by CMake as part of the build process. ** Linux @@ -35,8 +35,9 @@ And the dependencies with: #+begin_example bash sudo apt install \ libsfml-dev \ + fluidsynth \ libfluidsynth-dev \ - libboost-all-dev \ + libboost-all-dev #+end_example The midi functionality of chordcat is provided by libremidi. libremidi @@ -89,6 +90,18 @@ To install the Pulse development libraries on debian-based systems: sudo apt install libpulse-dev #+end_example +*** Building +Once you have all the dependencies you need for your system, build +and run chordcat with: + +#+begin_example bash +cd chordcat +mkdir build && cd build +cmake .. +make -j$(nproc) +./chordcat +#+end_example + ** MacOS WIP