Update README.md, added comments.

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - "*"
+    tags:
+      - "*"
+
+jobs:
+  build_rg3:
+    runs-on: ${{ matrix.config.os }}
+    strategy:
+      matrix:
+        config:
+          - { name: "Windows MSVC", os: windows-latest, cc: "cl", cxx: "cl", boost_toolset: msvc }
+
+    steps:
+      # Download repository with submodules
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      # Setup Ninja
+      - name: Get latests Ninja
+        uses: ashutoshvarma/setup-ninja@master
+
+      # Check cache of Boost & LLVM - take if exists
+      # Build Boost 1.81.0
+      # Build LLVM 15.0.0
+      # Build project via cmake
+      # Compress artifacts
+      # Send artifacts to GitHub

PyBind/rg3py_ext.pyi

@@ -1,3 +1,7 @@
+"""
+This file contains all public available symbols & definitions for PyBind (rg3py_ext.pyd)
+Follow PyBind/source/PyBind.cpp for details
+"""
 from typing import List
 
 

PyBind/source/PyBind.cpp

@@ -25,6 +25,7 @@ BOOST_PYTHON_MODULE(rg3py_ext)
 {
 	/**
 	 * Register base and trivial types here, other in impls
+	 * Please, don't forget to add your public available types into PyBind/rg3py_ext.pyi file!!!
 	 */
 	/// ----------- ENUMS -----------
 	enum_<rg3::cpp::TypeKind>("CppTypeKind")

README.md

@@ -27,7 +27,7 @@ When everything is done your plugin file `rg3ext_py.pyd` will be in `build` fold
 Usage:
 ------
 
-Just put `rg3ext_py.pyd` near to your python source file and it will be ready to use.
+Just copy `rg3ext_py.pyi` (hints for IDE) and `rg3ext_py.pyd` (native extension itself) into folder with your python code.
 
 Sample code:
 
@@ -66,3 +66,12 @@ Project state
 Now I'm working on first MVP and will use this project for codegen in my own engine.
 
 Stay tuned :) 
+
+Current limitations
+-------------------
+
+ * Currently I'm focused on Windows support. Linux & MacOS support will be later.
+ * Project WILL NOT support code inside function scope. I'm focused only on header analysis. Feel free to fork with project and make which analysis what you want.
+ * Multithreading: not supported now, but will be supported later.
+ * Context: not supported. Will do it later. 
+   * Workaround: main context focused in CodeAnalyzer, so you able to make 1 context per thread, that should be enough.