Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.68 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.68 KB

string-tension

This app lets you calculate the tension of strings on a guitar or bass, and is fully modifiable to accomodate a variety of instruments or strings.

Screenshot of the program

Running the program

Run ./string-tension to execute the program. You can modify any of the string parameters (length, gauge, type, note, and octave) to re-calculate tension. You can reset any modifications made, or switch to a bass preset by using the "Presets" choice widget.

You can also read more detailed usage of the program by pressing Ctrl + H, or viewing "Help" in the menu bar at the top of the window.

Building from source

To create Linux binaries

To build this project, run make in the top-level directory. This will create an executable named "string-tension" in the "build" directory. You can run make test to create the test executable, which will also appear in the build directory.

To cross-compile Windows binaries

You will additionally need g++ for mingw-w64, and fltk built for mingw-w64. With these installed, run mingw64-make -f Makefile-mingw64 to create an executable named "string-tension.exe" in the "build" directory.

Detailed documentation can be generated by running Doxygen in the top-level directory.

Build Requirements

  • g++
  • Fast Light Toolkit (FLTK)
  • Googletest (Optional, only required for testing)
  • Doxygen (Optional, used to generate HTML/LaTeX documentation)

License / Attribution

Copyright (C) 2022-2024 Aaron Ayub

This program is available under the MIT license.

This program is based in part on the work of the FLTK project.