Skip to content

BUILDING.md

Latest commit

 

History

History
112 lines (68 loc) · 4.52 KB

BUILDING.md

File metadata and controls

112 lines (68 loc) · 4.52 KB

Build instructions

Operating Systems

Windows

1. Install Visual Studio Community

  1. Download latest version from visualstudio.microsoft.com
  2. Launch downloaded Visual Studio installer
  3. Select "Desktop development with C++" before installation
  4. Unselect "vcpkg package manager" inside Installation details we will use our own
  5. Finally click Install button to begin installation

Alternatively you can install and use CLion, VSCode or any other IDE.

2. Install Git

You may use default Git install options or chose any other default Git editor instead of Vim.

3. Install CMake

  1. Download latest release version of installer from cmake.org
  2. Select "Add CMake to the system PATH for the current user" during installation

4. Clone repository

  1. Open Terminal or CMD app to execute following commands
  2. Change current working directory using cd command where to clone repository. (Google it)
  3. Run git clone --recursive -j8 https://github.com/cfnptr/nets command to download repository
  4. Run cd nets/ to enter repository directory

Note! Use appropriate github link if Nets is used as a third-party library.

5. Install vcpkg package manager

  1. Open CMD or Terminal app as Administrator. (Right click the app)
  2. Run scripts/update-vcpkg.bat command from the repository scripts/ directory
  3. Reopen CMD or Terminal app to get updated system environment variables.

Or

  1. Follow installation steps from learn.microsoft.com (Better to choose C:\vcpkg path)
  2. Run vcpkg integrate install command using Terminal or CMD app to make packages available user-wide
  3. Add vcpkg to the System Environment Variables. (Google it)

6. Install required packages

  1. Run vcpkg install openssl:x64-windows-static curl:x64-windows-static using Terminal or CMD app

macOS

1. Install Xcode and tools

  1. Download and install latest version from the built-in App Store
  2. Run xcode-select --install command using Terminal app to install Xcode tools

Alternatively you can install and use CLion, VSCode or any other IDE.

2. Install required packages

  1. Install Homebrew package manager from brew.sh
  2. Run brew update command using Terminal app to update package list
  3. And run brew install git cmake openssl curl command to install packages

Linux

1. Install Visual Studio Code (Or any other IDE)

  1. Download and install latest version from code.visualstudio.com or from built-in store
  2. Install "C/C++" and "CMake Tools" extensions inside the VS Code

Alternatively you can install and use CLion, VSCodium or any other IDE.

2. Install required packages

For Ubuntu/Debian

  1. Run sudo apt-get update command using Terminal app
  2. And sudo apt-get install git cmake build-essential libssl-dev libcurl4-openssl-dev

Build Project

Before building the project you should clone it: git clone --recursive -j8 <project-url>
To build the project run one of the scripts using Terminal, Git Bash or build it using IDE.

Visual Studio

  1. Open Visual Studio IDE application
  2. Click "Open a project or solution" and open the project CMakeLists.txt
  3. Wait for project CMake generation to finish
  4. Click Build -> Build All to build the project

Visual Studio Code (VS Code and VSCodium)

  1. Open Visual Studio Code IDE application
  2. Click File -> Open Folder... and open the project folder
  3. Select one of the compiler Kits in the opened window (Clang or GCC)
  4. Wait for project CMake generation to finish (may take some time)
  5. Click Build button at the bottom bar to build the project