Merge pull request #7 from danlangford/file-organization

new dir structure idea
pappde · Feb 21, 2021 · 15aba3c · 15aba3c
2 parents 2b98384 + b33ad19
commit 15aba3c
Show file tree

Hide file tree

Showing 17 changed files with 27 additions and 2 deletions.
diff --git a/BUILDING.MD b/BUILDING.MD
@@ -0,0 +1,25 @@
+The project leverages CMake, a cross-platform build management tool.
+Most popular IDEs, like CLion and Visual Studio, understand and support CMake based projects. 
+
+The C++ project structure I have chosen to follow is detailed on [Project Heuristics](https://medium.com/heuristics/c-application-development-part-1-project-structure-454b00f9eddc).
+The C++ convention for CMake builds is what is called an "out of source" build, meaning you give room for your build to generate artifacts that dont clutter your source directories. 
+The `.gitignore` has been tuned for out of source builds to happen in the `./build/` dir. 
+
+Consider using a pattern like the one below for your builds should you want to build the project in a non-IDE, command line way.
+
+*nix environments
+```sh
+mkdir -p build
+cd build
+cmake ..
+make
+```
+
+windows ms visual studio environments
+```sh
+\path\to\VsDevCmd.bat
+mkdir build
+cd build
+cmake ..
+devenv bmai.sln /build
+```
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -5,9 +5,9 @@ project(bmai)
 set(CMAKE_CXX_STANDARD 14)
 
 # to be able to reference header files
-include_directories(.)
+include_directories(./src)
 
 # to collect only needed source files
-set(SOURCE bmai.cpp bmai_ai.cpp bmai_player.cpp)
+set(SOURCE ./src/bmai.cpp ./src/bmai_ai.cpp ./src/bmai_player.cpp)
 
 add_executable(${PROJECT_NAME} ${SOURCE})
diff --git a/bmai.cpp → src/bmai.cpp b/bmai.cpp → src/bmai.cpp
diff --git a/bmai.h → src/bmai.h b/bmai.h → src/bmai.h
diff --git a/bmai_ai.cpp → src/bmai_ai.cpp b/bmai_ai.cpp → src/bmai_ai.cpp
diff --git a/bmai_ai.h → src/bmai_ai.h b/bmai_ai.h → src/bmai_ai.h
diff --git a/bmai_player.cpp → src/bmai_player.cpp b/bmai_player.cpp → src/bmai_player.cpp
diff --git a/bmai_in.txt → test/bmai_in.txt b/bmai_in.txt → test/bmai_in.txt
diff --git a/bmsim.in → test/bmsim_in.txt b/bmsim.in → test/bmsim_in.txt
diff --git a/bmsim.out → test/bmsim_out.txt b/bmsim.out → test/bmsim_out.txt
diff --git a/test.in → test/test_in.txt b/test.in → test/test_in.txt
diff --git a/test.out → test/test_out.txt b/test.out → test/test_out.txt
diff --git a/bmai.pl → web/bmai.pl b/bmai.pl → web/bmai.pl
diff --git a/bmai_run.pl → web/bmai_run.pl b/bmai_run.pl → web/bmai_run.pl
diff --git a/bmai_test.pl → web/bmai_test.pl b/bmai_test.pl → web/bmai_test.pl
diff --git a/dp_lib.pl → web/dp_lib.pl b/dp_lib.pl → web/dp_lib.pl
diff --git a/stats.pl → web/stats.pl b/stats.pl → web/stats.pl