release static libw2v (#6)

* release static libw2v
* GitHub Action for Make
* fix CMake for windows
* add CPack

Author: fogfish

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+##
+## release static library
+##
+name: release
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    permissions: write-all
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      matrix:
+        os: [ubuntu, macos]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: build
+        uses: fogfish/cmake_build_action@master
+        with:
+          config: ${{ matrix.configs }}
+          submodule_update: OFF
+          run_tests: OFF
+          cmake_args: -DCMAKE_BUILD_TYPE=Release ./libw2v
+          create_package: ON
+
+      - name: Upload binaries to release
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: libw2v/build/*.tar.gz
+          tag: ${{ github.ref }}
+          overwrite: true
+          file_glob: true

README.md

@@ -72,9 +72,9 @@ The project offers a solution as both a Golang module and a simple command-line
 
 ### Pre-requisites
 
-A dynamically linked library is required for the CGO bridge to integrate with Max Fomichev's word2vec C++ library. Ensure that the necessary C++ libraries are installed and properly configured on your system to use this functionality.
+A static linked library is required for the CGO bridge to integrate with Max Fomichev's word2vec C++ library. Ensure that the necessary C++ libraries are installed and properly configured on your system to use this functionality.
 
-To build the required dynamically linked library, use a C++11 compatible compiler and CMake 3.1 or higher. This step is essential before proceeding with the installation and usage of the Golang module.
+To build the required static linked library, use a C++11 compatible compiler and CMake 3.10 or higher. This step is essential before proceeding with the installation and usage of the Golang module.
 
 ```bash
 mkdir _build && cd _build
@@ -84,7 +84,7 @@ make
 cp ../libw2v/lib/libw2v.dylib /usr/local/lib/libw2v.dylib
 ```
 
-**Note**: The project does not currently distribute library binaries, though this feature is planned for a future version. You will need to build the binaries yourself for your target runtime. If you need assistance, please [raise an issue](https://github.com/fogfish/word2vec/issues).
+**Note**: The static linked libraries are distributed as binary, download them from [releases](https://github.com/fogfish/word2vec/releases) and extract it to `libw2v` dir.
 
 
 ## Usage Command line utility
@@ -172,6 +172,31 @@ Use `go get` to retrieve the library and add it as dependency to your applicatio
 go get -u github.com/fogfish/word2vec
 ```
 
+However, the availability of static library for the target platform (linux, darwin) is the primary requirement. There are two options finishing the installation the module.
+
+**Option 1: build the library (recommended)**
+
+```bash
+go get -u github.com/fogfish/word2vec
+
+git clone --depth=1 --branch=main https://github.com/fogfish/word2vec word2vec
+cd word2vec && cmake -DCMAKE_BUILD_TYPE=Release libw2v && make && cd ..
+go mod edit -replace github.com/fogfish/word2vec=./word2vec
+```
+
+**Option 2: using the pre-build library**
+
+```bash
+go get -u github.com/fogfish/word2vec
+
+git clone --depth=1 --branch=main https://github.com/fogfish/word2vec word2vec
+cd word2vec/libw2v
+curl -L -O https://github.com/fogfish/word2vec/releases/download/v0.0.0/w2v-0.0.0-Darwin.tar.gz
+tar -zxf w2v-0.0.0-Darwin.tar.gz --strip-components=1
+cd ../..
+go mod edit -replace github.com/fogfish/word2vec=./word2vec
+```
+
 ### Embeddings
 
 Calculate embeddings for either a single word or a bag of words.

libw2v/CMakeLists.txt

@@ -1,18 +1,24 @@
+cmake_minimum_required(VERSION 3.10)
 project (w2v)
-cmake_minimum_required(VERSION 3.1)
 
 set(PROJECT_ROOT_DIR ${CMAKE_SOURCE_DIR})
 set(LIBRARY_OUTPUT_PATH ${PROJECT_ROOT_DIR}/lib)
 
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Werror")
 set(CMAKE_CXX_FLAGS_DEBUG "-O0 -ggdb")
 set(CMAKE_CXX_FLAGS_RELEASE "-Ofast -march=native -funroll-loops -ftree-vectorize -DNDEBUG")
 
 set(PROJECT_INCLUDE_DIR ${PROJECT_ROOT_DIR}/include)
 
+if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+    message("-- Detecting Darwin - done")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Werror")
+endif()
+
 if (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
+    message("-- Detecting Linux - done")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Wpedantic -Werror")
     set(LIBS "-pthread")
 endif()
 
@@ -21,3 +27,15 @@ if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
 endif()
 
 add_subdirectory(src)
+
+set(CPACK_SOURCE_GENERATOR "TGZ")
+set(CPACK_PACKAGE_VERSION_MAJOR "0")
+set(CPACK_PACKAGE_VERSION_MINOR "0")
+set(CPACK_PACKAGE_VERSION_PATCH "0")
+set(CPACK_SOURCE_IGNORE_FILES
+  \\.git/
+  build/
+  ".*~$"
+)
+set(CPACK_VERBATIM_VARIABLES YES)
+include(CPack)

libw2v/src/CMakeLists.txt

@@ -1,5 +1,5 @@
+cmake_minimum_required(VERSION 3.10)
 project (w2v)
-cmake_minimum_required(VERSION 3.1)
 
 set (PROJECT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
@@ -37,7 +37,7 @@ set(PRJ_SRCS
         ${ADD_SRCS}
         )
 
-add_library(${PROJECT_NAME} SHARED ${PRJ_SRCS})
+add_library(${PROJECT_NAME} STATIC ${PRJ_SRCS})
 target_link_libraries(${PROJECT_NAME} ${LIBS})
 
 install(TARGETS ${PROJECT_NAME} DESTINATION lib)

libw2v/src/w2v.cpp

@@ -6,6 +6,7 @@
 
 #include <iostream>
 #include <iomanip>
+#include <cstring>
 #include <stdexcept>
 
 class H

word2vec.go

@@ -10,7 +10,7 @@ package word2vec
 
 /*
 #cgo CFLAGS: -Ilibw2v/include
-#cgo LDFLAGS: -L . -lw2v
+#cgo LDFLAGS: -Llibw2v/lib -lw2v -lstdc++
 #include <stdlib.h>
 #include "w2v.h"
 */