diff --git a/.github/workflows/format.yaml b/.github/workflows/format.yaml index 11f91f7..4d2a1c0 100644 --- 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 index be0976d..9097702 100644 --- a/README.md +++ b/README.md @@ -412,7 +412,7 @@ Open your terminal in the project's example directory: cd /example ``` -The examples' source files are in the `/example/src` directory. +The examples' source files are in the `/example/source` directory. > **Note:** Each source file is a sepparate example. @@ -485,7 +485,7 @@ 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) @@ -493,12 +493,12 @@ 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 ```
diff --git a/change_log.md b/change_log.md index 17951be..c8ca4f4 100644 --- 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 `/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 index eeb5d80..7db437b 100644 --- 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 b/example/source/convert_numbers.cpp similarity index 100% rename from example/src/convert_numbers.cpp rename to example/source/convert_numbers.cpp diff --git a/example/src/merge_files.cpp b/example/source/merge_files.cpp similarity index 100% rename from example/src/merge_files.cpp rename to example/source/merge_files.cpp diff --git a/example/src/power.cpp b/example/source/power.cpp similarity index 100% rename from example/src/power.cpp rename to example/source/power.cpp diff --git a/example/src/verbosity.cpp b/example/source/verbosity.cpp similarity index 100% rename from example/src/verbosity.cpp rename to example/source/verbosity.cpp diff --git a/scripts/install_clang_format_17.sh b/scripts/env/install_clang_format_17.sh similarity index 100% rename from scripts/install_clang_format_17.sh rename to scripts/env/install_clang_format_17.sh diff --git a/scripts/format_unix.sh b/scripts/format/unix.sh similarity index 100% rename from scripts/format_unix.sh rename to scripts/format/unix.sh diff --git a/scripts/format_win.ps1 b/scripts/format/windows.ps1 similarity index 100% rename from scripts/format_win.ps1 rename to scripts/format/windows.ps1 diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index db4e883..8c9af97 100644 --- 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 b/test/source/test_argument_name.cpp similarity index 100% rename from test/src/test_argument_name.cpp rename to test/source/test_argument_name.cpp diff --git a/test/src/test_argument_parser_add_argument.cpp b/test/source/test_argument_parser_add_argument.cpp similarity index 100% rename from test/src/test_argument_parser_add_argument.cpp rename to test/source/test_argument_parser_add_argument.cpp diff --git a/test/src/test_argument_parser_info.cpp b/test/source/test_argument_parser_info.cpp similarity index 100% rename from test/src/test_argument_parser_info.cpp rename to test/source/test_argument_parser_info.cpp diff --git a/test/src/test_argument_parser_parse_args.cpp b/test/source/test_argument_parser_parse_args.cpp similarity index 100% rename from test/src/test_argument_parser_parse_args.cpp rename to test/source/test_argument_parser_parse_args.cpp diff --git a/test/src/test_boolean.cpp b/test/source/test_boolean.cpp similarity index 100% rename from test/src/test_boolean.cpp rename to test/source/test_boolean.cpp diff --git a/test/src/test_nargs_range.cpp b/test/source/test_nargs_range.cpp similarity index 100% rename from test/src/test_nargs_range.cpp rename to test/source/test_nargs_range.cpp diff --git a/test/src/test_optional_argument.cpp b/test/source/test_optional_argument.cpp similarity index 100% rename from test/src/test_optional_argument.cpp rename to test/source/test_optional_argument.cpp diff --git a/test/src/test_positional_argument.cpp b/test/source/test_positional_argument.cpp similarity index 100% rename from test/src/test_positional_argument.cpp rename to test/source/test_positional_argument.cpp