Skip to content

Commit

Permalink
Update Linux build instructions: new CMakeLists changes
Browse files Browse the repository at this point in the history
  • Loading branch information
shriramters committed Jun 22, 2024
1 parent bef0a9c commit e65554c
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions content/docs/building-from-source.org
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit e65554c

Please sign in to comment.