ready for first release

- bump up license year.
- format some gitignore files.
- update PyBMap readme.
- create a distribution used folder and give a manual for it.

.gitignore

@@ -1,13 +1,18 @@
-## my ban
+# -------------------- Personal --------------------
+# Ignore all possible test used Virtools files
 *.nmo
 *.cmo
 *.nms
 *.vmo
-out/
+
-temp/
+# Ignore temporary folders
+/out/
+/temp/
+
+# -------------------- VSCode --------------------
 .vscode/
 
-## CMake Banned
+# -------------------- CMake --------------------
 CMakeLists.txt.user
 CMakeCache.txt
 CMakeFiles
@@ -20,6 +25,7 @@ compile_commands.json
 CTestTestfile.cmake
 _deps
 
+# -------------------- Visual Studio --------------------
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##

BMapBindings/PyBMap/.gitignore

@@ -1,12 +1,18 @@
-# my ban
+# -------------------- Personal --------------------
+# Ignore VSCode
 .vscode/
+
+# Ignore binary BMap stuff
 *.dll
 *.pdb
 *.so
 *.dylib
 *.bin
+
+# Ignore testbench file.
 testbench.py
 
+# -------------------- Python --------------------
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

BMapBindings/PyBMap/README.md

@@ -1,6 +1,5 @@
 # PyBMap
 
-The real scripts are placed in sub PyBMap folder. This folder is served for testbench scripts placing.  
+The real scripts are placed in sub PyBMap folder. This folder is served for testbench scripts placing. Place any testbench files (e.g. `testbench.py`) in there what you want and don't sumbit them (`testbench.py` is explicitly excluded by gitignore file).
-Place any testbench files (e.g. `testbench.py`) in there what you want and don't sumbit them.  
+
-The native BMap library should be placed in sub PyBMap folder, and I have used gitignore file to filter them.  
+The native BMap library should be placed in sub PyBMap folder, and I have used gitignore file to filter them. The native BMap library must be named as `BMap.dll` (in Windows), `BMap.so` (in Linux or BSD), or `BMap.dylib` (in macOS). If you still can not load BMap or your system is not listed above, you should name it as `BMap.bin`.
-The native BMap library must be named as `BMap.dll` (in Windows), `BMap.so` (in Linux or BSD), or `BMap.dylib` (in macOS). If you still can not load BMap or your system is not listed above, you should name it as `BMap.bin`.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022-2023 yyc12345
+Copyright (c) 2022-2024 yyc12345
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Redist/.gitignore

@@ -0,0 +1,7 @@
+# Disable all file and folder
+/*
+/*/
+
+# Only upload specific files
+!/.gitignore
+!/README.md

Redist/README.md

@@ -0,0 +1,43 @@
+# LibCmo21 Redist
+
+This folder is served for LibCmo21 distribution and this page will introduce how to distribute a LibCmo21.
+
+In this article, I assume:
+* This distribution is served for Windows user.
+* All Linux will use this project by compiling it on themselves.
+* You are using Visual Studio under Windows, not CMake.
+* User will only need x64 architecture, not Win32 (x86).
+
+## Common
+
+1. Copy project `LICENSE` into folder.
+
+## Unvirt
+
+1. Compile project with `x64 | Release` profile.
+1. Create folder `Unvirt` and enter it.
+1. Copy generated `Unvirt.exe` and `Unvirt.pdb` into folder.
+1. Copy zlib binary `zlibwapi.dll` into folder.
+
+## BMap
+
+1. Compile project with `x64 | Release` profile.
+1. Create folder `BMap` and enter it.
+1. Copy generated `BMap.dll` and `BMap.pdb` into folder.
+1. Copy zlib binary `zlibwapi.dll` into folder.
+
+## PyBMap
+
+1. Compile project with `x64 | Release` profile.
+1. Create folder `PyBMap` and enter it.
+1. Copy all files ending with  `.py` and located in folder `BMapBindings/PyBMap/PyBMap` into folder.
+1. Copy generated `BMap.dll` and `BMap.pdb` into folder.
+1. Copy zlib binary `zlibwapi.dll` into folder.
+
+## BMapSharp
+
+This project is not ready for release.
+
+## Ending
+
+1. Pack all files and folders except `.gitignore` and `README.md` in this folder.

Tools/.gitignore

@@ -1,5 +1,4 @@
-# Result
+# Ignore test used 3d Object
-
 *.bin
 *.obj
 *.mtl