reorganized project folder structure

SpectraL519 · Feb 17, 2024 · 6e27a52 · 6e27a52
1 parent 3fe26ba
commit 6e27a52
Show file tree

Hide file tree

Showing 20 changed files with 11 additions and 8 deletions.
diff --git a/.github/workflows/format.yaml b/.github/workflows/format.yaml
@@ -19,7 +19,7 @@ jobs:
       - name: Prepare
         shell: bash
         run: |
-          sudo ./scripts/install_clang_format_17.sh
+          sudo bash ./scripts/env/install_clang_format_17.sh
         continue-on-error: false
 
       - name: Test formatting

diff --git a/README.md b/README.md
@@ -412,7 +412,7 @@ Open your terminal in the project's example directory:
 cd <project-root>/example
 ```
 
-The examples' source files are in the `<project-root>/example/src` directory.
+The examples' source files are in the `<project-root>/example/source` directory.
 
 > **Note:** Each source file is a sepparate example.
 
@@ -485,20 +485,20 @@ Run the tests:
 
 > **NOTE:** The project uses `clang-format-17`.
 >
-> To install this tool on ubuntu run `sudo ./scripts/install_clang_format_17.sh`.
+> To install this tool on ubuntu run `sudo ./scripts/env/install_clang_format_17.sh`.
 >
 > On windows you can download the LLVM package from the official LLVM [GitHub release page](https://github.com/llvm/llvm-project/releases/tag/llvmorg-17.0.1)
 
 To format the code use run the following:
 
 ```shell
 # Unix platforms
-./scripts/format_unix.sh
+./scripts/format/unix.sh
 ```
 
 ```shell
 # Windows: powershell
-./scripts/format_win.ps1
+./scripts/format/windows.ps1
 ```
 
 <br />

diff --git a/change_log.md b/change_log.md
@@ -18,8 +18,11 @@
 ### Version 1.1
 
 * Added `change_log.md`
+* Reorganized project folder strucure:
+    * Renamed folders `src` to `source`
+    * Moved formatting scripts to `scripts/format/`
 * Aligned the `.clang-format` configuration file and moved formatting scripts to a new directory `<project-root>/scripts`
-* Added the `install_clang_format_17.sh` script
+* Added the `install_clang_format_17.sh` env script
 * Added the `format` workflow
 
 TODO:

diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.12)
 project(cpp-ap-examples)
 
 # Structure
-set(SOURCE_DIR "src")
+set(SOURCE_DIR "source")
 set(INCLUDE_DIRS "include" "../include")
 set(BINARY_DIR "bin")
 set(EXECUTABLE_DIR "bin")

diff --git a/example/src/convert_numbers.cpp → example/source/convert_numbers.cpp b/example/src/convert_numbers.cpp → example/source/convert_numbers.cpp
diff --git a/example/src/merge_files.cpp → example/source/merge_files.cpp b/example/src/merge_files.cpp → example/source/merge_files.cpp
diff --git a/example/src/power.cpp → example/source/power.cpp b/example/src/power.cpp → example/source/power.cpp
diff --git a/example/src/verbosity.cpp → example/source/verbosity.cpp b/example/src/verbosity.cpp → example/source/verbosity.cpp
diff --git a/scripts/install_clang_format_17.sh → scripts/env/install_clang_format_17.sh b/scripts/install_clang_format_17.sh → scripts/env/install_clang_format_17.sh
diff --git a/scripts/format_unix.sh → scripts/format/unix.sh b/scripts/format_unix.sh → scripts/format/unix.sh
diff --git a/scripts/format_win.ps1 → scripts/format/windows.ps1 b/scripts/format_win.ps1 → scripts/format/windows.ps1
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -5,7 +5,7 @@ cmake_minimum_required(VERSION 3.12)
 project(cpp-ap-test)
 
 # Structure
-set(SOURCE_DIRS "src" "app")
+set(SOURCE_DIRS "source" "app")
 set(INCLUDE_DIRS "include" "../include")
 set(BINARY_DIR ".")
 set(EXECUTABLE_DIR ".")

diff --git a/test/src/test_argument_name.cpp → test/source/test_argument_name.cpp b/test/src/test_argument_name.cpp → test/source/test_argument_name.cpp
diff --git a/...src/test_argument_parser_add_argument.cpp → ...rce/test_argument_parser_add_argument.cpp b/...src/test_argument_parser_add_argument.cpp → ...rce/test_argument_parser_add_argument.cpp
diff --git a/test/src/test_argument_parser_info.cpp → test/source/test_argument_parser_info.cpp b/test/src/test_argument_parser_info.cpp → test/source/test_argument_parser_info.cpp
diff --git a/test/src/test_argument_parser_parse_args.cpp → ...ource/test_argument_parser_parse_args.cpp b/test/src/test_argument_parser_parse_args.cpp → ...ource/test_argument_parser_parse_args.cpp
diff --git a/test/src/test_boolean.cpp → test/source/test_boolean.cpp b/test/src/test_boolean.cpp → test/source/test_boolean.cpp
diff --git a/test/src/test_nargs_range.cpp → test/source/test_nargs_range.cpp b/test/src/test_nargs_range.cpp → test/source/test_nargs_range.cpp
diff --git a/test/src/test_optional_argument.cpp → test/source/test_optional_argument.cpp b/test/src/test_optional_argument.cpp → test/source/test_optional_argument.cpp
diff --git a/test/src/test_positional_argument.cpp → test/source/test_positional_argument.cpp b/test/src/test_positional_argument.cpp → test/source/test_positional_argument.cpp