Merge pull request #14 from alpinebuster/dev

Dev

Author: alpinebuster

.github/workflows/update-docs-manual.yml

@@ -76,6 +76,3 @@
 [submodule "thirdparty/OpenCTM-git"]
 	path = thirdparty/OpenCTM-git
 	url = https://github.com/MeshInspector/OpenCTM.git
-[submodule "docs/doxygen-awesome-css"]
-	path = docs/doxygen-awesome-css
-	url = https://github.com/jothepro/doxygen-awesome-css

.github/workflows/update-docs.yml

@@ -70,7 +70,8 @@
 			"atomic": "cpp",
 			"bit": "cpp",
 			"random": "cpp",
-			"adolcforward": "cpp"
+			"adolcforward": "cpp",
+			"*.inc": "cpp"
 		}
 	}
 }

.gitmodules

@@ -10,9 +10,9 @@ IF(NOT MR_EMSCRIPTEN AND NOT APPLE AND EXISTS /usr/bin/time)
   set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK "/usr/bin/time -f \",%U,%S,%C\" -a -o link_timings.txt")
 ENDIF()
 
-project(MeshLib CXX)
+project(MeshSDK CXX)
 
-set(MESHLIB_PROJECT_NAME "MeshLib" CACHE STRING "Project name")
+set(MESHLIB_PROJECT_NAME "MeshSDK" CACHE STRING "Project name")
 add_compile_definitions(MR_PROJECT_NAME=\"${MESHLIB_PROJECT_NAME}\")
 
 include(CompilerOptions)

.vscode/meshsdk.code-workspace

@@ -39,35 +39,53 @@ The MeshSDK is an open-source library that provides advanced algorithms for 3D d
 
 ### Linux & MacOS
 
+Install emscripten toolkit:
+
+```sh
+# Fetch the latest version of the emsdk (not needed the first time you clone)
+git pull
+
+# Download and install the latest SDK tools.
+# ./emsdk install latest # ⚠️
+./emsdk install 4.0.10
+
+# Make the "latest" SDK "active" for the current user. (writes .emscripten file)
+# ./emsdk activate latest # ⚠️
+./emsdk activate latest
+
+# Activate PATH and other environment variables in the current terminal
+source ./emsdk_env.sh
+```
+
+Build source code:
+
 ```sh
 git submodule update --init
+
 ./scripts/build_thirdparty.sh
 ./scripts/build_source.sh
-
-# Common sense
-emcc --clear-cache
 ```
 
 ### Docker
 
 ```sh
-`docker compose up --build meshlib-emscripten-build`
+`docker compose up --build meshsdk-emscripten-build`
 
-`docker compose up meshlib-emscripten-build`
-`docker compose up meshlib-emscripten-build -d`
+`docker compose up meshsdk-emscripten-build`
+`docker compose up meshsdk-emscripten-build -d`
 
 `docker compose --profile singlethreaded up meshlib-emscripten-build-singlethreaded`
 `docker compose --profile wasm64 up meshlib-emscripten-build-wasm64`
 
 #
 # To run custom build commands:
 #
-`docker compose exec meshlib-emscripten-build bash`
-`docker compose exec meshlib-emscripten-build-singlethreaded bash`
-`docker compose exec meshlib-emscripten-build-wasm64 bash`
+`docker compose exec meshsdk-emscripten-build bash`
+`docker compose exec meshsdk-emscripten-build-singlethreaded bash`
+`docker compose exec meshsdk-emscripten-build-wasm64 bash`
 ```
 
-### Windows
+### Windows (Desktop)
 
 #### Prerequisites
  1. **Git**
@@ -80,7 +98,7 @@ emcc --clear-cache
  3. **CUDA Toolkit**
   - For **Visual Studio 2019**: Install [CUDA v11.4](https://developer.nvidia.com/cuda-11-4-0-download-archive)
   - For **Visual Studio 2022**: Install [CUDA v12.0](https://developer.nvidia.com/cuda-12-0-0-download-archive)
- \n Choose the appropriate version based on your Visual Studio installation.
+ Choose the appropriate version based on your Visual Studio installation.
  4. **vcpkg**
   - To install `vcpkg`, follow these steps:
    1. **Open a command prompt (CMD) or PowerShell window**.
@@ -114,29 +132,29 @@ vcpkg integrate install
 [Learn more about](https://github.com/Microsoft/vcpkg) `vcpkg`
 
 #### Installing the local build
-\note The following steps will require approximately 40 GB of disk space.
+The following steps will require approximately 40 GB of disk space.
 
  1. **Clone the Submodules**:
 ```cmd
 git submodule update --init
 # or
 git submodule update --init --recursive
 ```
- 2. \b (Optional) **Speed Up with AWS CLI**
+ 2. (Optional) **Speed Up with AWS CLI**
   - Optionally, [install AWS CLI v2](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) to speed up the process before using the Installation Script. Restart your terminal after installation.
  3. **Install Third-Party Dependencies**
   - Execute the following commands to run the third-party installation script:
 ```cmd
 cd vcpkg
-..\meshlib\thirdparty\install.bat
+..\meshsdk\thirdparty\install.bat
 ```
   - This script automates the installation of necessary third-party dependencies.
  4. **Build and Run Visual Studio Solution**
-  - Open `meshlib/source/MeshLib.sln` in Visual Studio.
+  - Open `meshsdk/source/MeshLib.sln` in Visual Studio.
   - Build the solution and run the application.
  5. **Build and Run CMake Project**
   - Make sure you have the "C++ CMake tools for Windows" component installed.
-  - Open `meshlib/CMakeLists.txt` in Visual Studio (File - Open - CMake).
+  - Open `meshsdk/CMakeLists.txt` in Visual Studio (File - Open - CMake).
   - Build the project and run the application.
 
 ### Installation
@@ -146,18 +164,18 @@ cd vcpkg
 Install with npm or yarn:
 
 ```sh
-npm install @alpinebuster/meshlib
-yarn add @alpinebuster/meshlib
+npm install @alpinebuster/meshsdk
+yarn add @alpinebuster/meshsdk
 ```
 
 #### Python
 
 For Python, simply install via pip:  
 
-```
+```sh
 pip install meshlib
 ```
 
 ## **License**
 
-Here, you can access our [Non-Commercial Free License](https://github.com/MeshInspector/MeshLib?tab=License-1-ov-file#readme) with a Commercial License Requirement. Also, see extra details on the [license page](https://meshlib.io/license/).
+Here, you can access our Non-Commercial Free License with a Commercial License Requirement. Also, see [license](./LICENSE).