Backport #120 and readme updates to release-0.7 (#121)

* Updated README to 0.7.0 release

* Use fixed runners OS version in CI

Author: GlebChili

.github/workflows/ci.yml

@@ -127,7 +127,7 @@ jobs:
 
  windows-build:
 
-   runs-on: windows-latest
+   runs-on: windows-2019
 
    steps:
      - name: Checkout
@@ -234,7 +234,7 @@ jobs:
 
  mac-build:
 
-    runs-on: macos-latest
+    runs-on: macos-10.15
 
     steps:
 
@@ -294,7 +294,7 @@ jobs:
 
  trigger_autorebase:
 
-   runs-on: ubuntu-latest
+   runs-on: ubuntu-20.04
 
    needs: [linux-build, windows-build, mac-build]
 

README.md

@@ -2,9 +2,8 @@
 [![CI](https://github.com/GlebChili/GmodDotNet/workflows/CI/badge.svg?branch=master)](https://github.com/GlebChili/GmodDotNet/actions?query=workflow%3ACI)
 
 # Gmod.NET
-[![Current Runtime](https://img.shields.io/badge/Current%20Runtime-0.6.0-2db94e)](https://github.com/GlebChili/GmodDotNet/wiki/GmodNET-Runtime-and-GmodNET.API-version-correspondence#gmodnet-and-gmodnetapi) [![Current API](https://img.shields.io/badge/Current%20API-0.6.0-2db94e)](https://github.com/GlebChili/GmodDotNet/wiki/GmodNET-Runtime-and-GmodNET.API-version-correspondence#gmodnet-and-gmodnetapi)
 
-Cross-platform .NET Module/Plugin platform for Garry's Mod powered by [__.NET Core__](https://dotnet.microsoft.com/).
+Cross-platform .NET Module/Plugin platform for Garry's Mod powered by [__.NET__](https://dotnet.microsoft.com/).
 
 ## About
 
@@ -13,17 +12,13 @@ and other .NET languages which runs across all platforms (Windows,
 Linux, Mac Os). Gmod.NET allows you to develop cross-platform Garry's Mod extensions without
 need to close or reload your game or server.
 
-## Similar projects
-
-Check out [gmod_csModuleLoader](https://github.com/dedady157/gmod_csModuleLoader) by [Bailey Drahoss](https://github.com/dedady157).
-
-## Current features
-
-GmodNET provides functionality to write Garry's Mod modules in C# or any other CIL-compiled language as [__.NET Core 3.1__](https://dotnet.microsoft.com/) class libraries. For more information on modules and API check out [project's wiki](https://github.com/GlebChili/GmodDotNet/wiki). Only `x86_64` version of Garry's Mod is currently supported.
+Gmod.NET allows you to write Garry's Mod modules in C# or any other CIL-compiled language as [__.NET 6.0__](https://dotnet.microsoft.com/) class libraries. 
+For more information on modules and API check out [our documentation](https://docs.gmodnet.xyz/). 
+Only `x86_64` version of Garry's Mod is currently supported.
 
 ## Need help?
 
-Check out our [wiki](https://github.com/GlebChili/GmodDotNet/wiki) or join our [discord server](https://discord.gg/9bP8nMT).
+Check out [our docs](https://docs.gmodnet.xyz/) and join our [discord server](https://discord.gg/9bP8nMT).
 
 ## Building and contributing
 
@@ -37,7 +32,7 @@ To build GmodDotNet you need to have following software installed and registered
 
 3. Latest version of dotnet SDK
 
-4. (On Windows) Latest version of Visual Studio 2019 with C++ package
+4. (On Windows) Latest version of Visual Studio 2019 with C++ workload
 
 5. (On macOS) Latest version of Xcode
 
@@ -49,7 +44,7 @@ Build steps:
 
 2. In the root of the cloned repository run `dotnet build runtime.csproj -c Debug` or `dotnet build runtime.csproj -c Release` instruction in your command prompt.
 
-__NOTE__: `runtime.csproj` is not a real C# project file but a kind of build script. To work with the managed part of GmodDotNet open `gm_dotnet_managed/gm_dotnet_managed.sln` solution file in your IDE instead.
+__NOTE__: `runtime.csproj` is not a real C# project file but a kind of build script. To work with the managed part of Gmod.NET open `gm_dotnet_managed/gm_dotnet_managed.sln` solution file in your IDE instead.
 
 `runtime.csproj` build script will produce following folders in the root of repository:
 
@@ -59,22 +54,9 @@ __NOTE__: `runtime.csproj` is not a real C# project file but a kind of build scr
 
 3. `nupkgs` folder contains `GmodNET.API` NuGet package.
 
-You may also want to copy the content of `lua` folder to the corresponding destinations in `garrysmod/lua`.
-
-### Folder structure
-
-Gmod.NET is subdivided into three subprojects.
-
-Garry's Mod binary native module and helper libraries are
-contained in `gm_dotnet_native` folder and organized as CMake project.
-
-Managed part is contained in `gm_dotnet_managed` folder and organized with .NET soultion file `gm_dotnet_managed.sln`.
-
-Bootstrap Lua scripts are contained in `lua` folder.
-
 ### Nightly builds
 
-You can find latest nightly builds GmodDotNet runtime at http://nightly.gmodnet.xyz/. To use nightly NuGet packages connect to [our nightly NuGet feed](https://dev.azure.com/GmodNET/gmodnet-artifacts/_packaging?_a=feed&feed=gmodnet-packages).
+You can find latest nightly builds of Gmod.NET runtime at http://nightly.gmodnet.xyz/. To use our nightly NuGet packages connect to [our nightly NuGet feed](https://dev.azure.com/GmodNET/gmodnet-artifacts/_packaging?_a=feed&feed=gmodnet-packages).
 
 ## Installation and usage
 
@@ -84,32 +66,18 @@ You can find latest nightly builds GmodDotNet runtime at http://nightly.gmodnet.
 
 3. Create a `Modules` folder inside `garrysmod/lua/bin/`.
 
-4. Download and copy `gm_dotnet_server.lua` to `garrysmod/lua/autorun/server` folder.
-
-5. Download and copy `gm_dotnet_client.lua` to `garrysmod/lua/autorun/client` folder.
+4. Place your .NET module, ...deps.json file, and all dependencies in `Modules/%exact_name_of_the_module_without_dll%/` folder.
 
-6. Place your .NET module, ...deps.json file, and all dependencies in `Modules/%exact_name_of_the_module_without_dll/` folder.
+5. Load Gmod.NET runtime in game by executing Lua function `require("dotnet")`.
 
-7. If you signed your module with [GmodNetModuleSigner](https://github.com/GlebChili/GmodNetModuleSigner), copy `[name_of_your_module].modulekey` and `[name_of_your_module].modulesign` to the same folder as above (`Modules/%exact_name_of_the_module_without_dll/`).
+6. Load your module by running Lua function `dotnet.load("%exact_name_of_the_module_without_dll%")`.
 
-8. If you want your module to be serverside (clientside) only then add file `TYPE` to `Modules/%exact_name_of_the_module_without_dll/` with content `server` (`client`).
-
-9. Use `gmod_net_load_all` (`gmod_net_load_all_cl` for client-side) console command to load all managed modules and `gmod_net_unload_all` (`gmod_net_unload_all_cl`) to unload them. Modules can be hot-reloaded, so one doesn't need to quit game to see changes.
+For more info check out [our quick start guide](https://docs.gmodnet.xyz/articles/tutorials/hello-world/index.html).
 
 ## License
 
 Whole project is licensed under MIT License.
 
 ## Dependencies and code usage
 
-Gmod.NET is making use of or borrows code from the following projects:
-
-1. [CoreCLR](https://github.com/dotnet/coreclr), [CoreFX](https://github.com/dotnet/corefx), and [core-setup](https://github.com/dotnet/core-setup) by [.NET Foundation](https://github.com/dotnet) (MIT License)
-
-2. [pure_lua_SHA](https://github.com/Egor-Skriptunoff/pure_lua_SHA) by [Egor Skriptunoff](https://github.com/Egor-Skriptunoff) (MIT License)
-
-3. [NSec](https://nsec.rocks/) by [Klaus Hartke](https://github.com/ektrah) (MIT License)
-
-4. [Libsodium](http://libsodium.org) by [Frank Denis](https://github.com/jedisct1) (ISC License)
-
-See other copyright notices in the NOTICE file.
+See the NOTICE file.