Preparing for merge to main

Author: arbCoding

CMakeLists.txt

@@ -25,12 +25,6 @@ FetchContent_Declare(xoshiro
 FetchContent_MakeAvailable(Catch2 xoshiro)
 # Include Xoshiro since it doesn't have a CMakeLists.txt
 include_directories(${xoshiro_SOURCE_DIR})
-# HomeBew Boost on macOS
-#find_package(Boost 1.83 REQUIRED CONFIG HINTS /opt/homebrew/Cellar/boost/1.83.0/lib/cmake)
-#if (Boost_FOUND)
-#  message("-- Boost_INCLUDE_DIRS=${Boost_INCLUDE_DIRS}")
-#  include_directories(${Boost_INCLUDE_DIRS})
-#endif()
 #===============================================================================
 # Flags
 #===============================================================================
@@ -53,7 +47,10 @@ project(sac-format
   LANGUAGES CXX
   DESCRIPTION "C++20 Single-Header SAC File library"
   HOMEPAGE_URL https://arbCoding.github.io/sac-format
-  VERSION 0.9.0)
+  VERSION 0.2.0)
+
+include_directories(${sac-format_SOURCE_DIR}/src)
+
 # Use C++20
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -65,14 +62,15 @@ add_library(sac-format STATIC
 
 set_target_properties(sac-format PROPERTIES VERSION ${PROJECT_VERSION})
 set_target_properties(sac-format PROPERTIES PUBLIC_HEADER src/sac_format.hpp)
+
 #===============================================================================
 # Example programs
 #===============================================================================
-add_executable(sac_list
+add_executable(list_sac
   src/sac_format.hpp
-  src/sac_list.cpp)
+  src/examples/list_sac.cpp)
 
-target_link_libraries(sac_list
+target_link_libraries(list_sac
   sac-format)
 #===============================================================================
 # Unit tests

docs/index.html

@@ -34,8 +34,9 @@ See the [[Benchmarking][Benchmarking]] section for more information.
 *** Easy
 
 sac-format is *easy*---single-header makes integration in any project simple.
-[[https://cmake.org/][CMake]] makes building on different platforms a breeze. Object-oriented design
-makes use easy and intuitive. See the [[Quickstart][Quickstart]] section to get up and running.
+Building is a breeze with [[https://cmake.org/][CMake]], even on different platforms. Object-oriented
+design makes use easy and intuitive. See the [[Quickstart][Quickstart]] section to get up and
+running.
 
 *** Small
 
@@ -95,9 +96,9 @@ To use link to the compiled library (=libsac-format.a= on Linux/macOS,
 
 ** Example Programs
 
-*** =sac_list=
+*** =list_sac=
 
-=sac_list= is a command line program that takes a single SAC-file as its input
+=list_sac= is a command line program that takes a single SAC-file as its input
 argument. It reads the SAC-file and outputs the header/footer information, as
 well as the true size of the [[=data1=][=data1=]] and [[=data2=][=data2=]] vectors.
 
@@ -190,12 +191,15 @@ int main() {
 
 ** Source File List
 
-*** =sac_format.hpp=
-*** =sac_format.cpp=
-*** =util.hpp=
-*** =utests.cpp=
-*** =benchmark.cpp=
-*** =sac_list.cpp=
+*** Core
+**** =sac_format.hpp=
+**** =sac_format.cpp=
+*** Testing and Benchmarking
+**** =util.hpp=
+**** =utests.cpp=
+**** =benchmark.cpp=
+*** Example programs
+**** =list_sac.cpp=
 
 
 ** Dependencies

docs/sac-format_manual.pdf

@@ -51,7 +51,7 @@
     \vspace{4\baselineskip}
     {\Huge User Manual}\\
     \vspace{4\baselineskip}
-    {\Large Version: 0.9.0}\\
+    {\Large Version: 0.2.0}\\
     \vspace{10\baselineskip}
     {\Large\textsc{Alexander R. Blanchette}\par}
     \vspace{10\baselineskip}

src/docs/index.org

@@ -17,9 +17,6 @@
 #include <string>
 #include <unordered_map>
 #include <vector>
-/* Boost string algorithms */
-// No longer using, keeping here in-case want to re-add in future
-//#include <boost/algorithm/string.hpp>
 
 namespace sacfmt {
 //--------------------------------------------------------------------------

src/docs/misc/settings.org

@@ -59,6 +59,11 @@ Short and succinct
 **** DONE Dependencies
 *** DONE PDF :pdf:
 This involves setting up the export settings for the website for LaTeX.
+** TODO Example programs
+*** DONE list_sac
+*** TODO convert_sac
+Take a sacfile and an input flag for version (6/7), write out as updated version.
+*** TODO inspect_sac
 ** DONE Namespace sacfmt
 ** DONE Make single-header!
 * Inbox