diff --git a/docs/howtouse.md b/docs/howtouse.md deleted file mode 100644 index a761c55..0000000 --- a/docs/howtouse.md +++ /dev/null @@ -1,17 +0,0 @@ -## How to use -1. Download latest module version from the **Release** page -2. Unzip downloaded archive into your server directory (you should now have **PyG2O.xYY.dll**, **python312.dll** and **libs/** in your root server directory) -3. Place .DLL module in the place you want and connect it with **config.xml** -```xml - -``` -4. Create **scripts/** folder in your server root directory, and put an empty ``__init__.py`` file inside it - -Now, your **scripts/** folder is a Python package and serves as an entry point. You can't rename it (at least for now), but inside this folder you can use any file structure you want. - -Your entry point should import PyG2O library: -```python -import g2o -# your code -``` -If you make package that uses PyG2O functions, then this package also should also contain import. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index ad08ae1..a761c55 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,17 @@ -# Blank \ No newline at end of file +## How to use +1. Download latest module version from the **Release** page +2. Unzip downloaded archive into your server directory (you should now have **PyG2O.xYY.dll**, **python312.dll** and **libs/** in your root server directory) +3. Place .DLL module in the place you want and connect it with **config.xml** +```xml + +``` +4. Create **scripts/** folder in your server root directory, and put an empty ``__init__.py`` file inside it + +Now, your **scripts/** folder is a Python package and serves as an entry point. You can't rename it (at least for now), but inside this folder you can use any file structure you want. + +Your entry point should import PyG2O library: +```python +import g2o +# your code +``` +If you make package that uses PyG2O functions, then this package also should also contain import. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 4b3a113..36d4465 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,7 +15,7 @@ plugins: repo_url: https://github.com/AURUMVORXX/PyG2O.git nav: - - How to use: howtouse.md + - How to use: index.md - QnA: qna.md - Classes: - Network: