Skip to content

Commit ff5ef53

Browse files
committed
Add docs, doxyfile, better scripts
1 parent 8f35f2a commit ff5ef53

File tree

108 files changed

+11838
-432
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+11838
-432
lines changed

BUILDING.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Build instructions
2+
3+
## Operating Systems
4+
5+
* [Window (10/11)](BUILDING.md#windows-1011)
6+
* [Ubuntu (22.04 LTS)](BUILDING.md#ubuntu-2204-lts)
7+
* [macOS (Ventura 13)](BUILDING.md#macos-ventura-13)
8+
* [Build Project](BUILDING.md#build-project)
9+
10+
11+
# Windows (10/11)
12+
13+
## 1. Install Visual Studio Community (Or any other IDE)
14+
15+
1. Download latest version from [visualstudio.microsoft.com](https://visualstudio.microsoft.com/downloads)
16+
2. Launch downloaded Visual Studio installer
17+
3. Select "Desktop development with C++" before installation
18+
4. Then click **Install** button to begin installation
19+
20+
## 2. Install Git
21+
22+
* Download and install latest version from [git-cms.com](https://git-scm.com/downloads)
23+
24+
You may use default Git install options or chose any other default Git editor instead of **Vim**.
25+
26+
## 3. Install CMake
27+
28+
1. Download latest release version of installer from [cmake.org](https://cmake.org/download)
29+
2. Select "Add CMake to the system PATH for the current user" during installation
30+
31+
# Ubuntu (22.04 LTS)
32+
33+
## 1. Install Visual Studio Code (Or any other IDE)
34+
35+
1. Download and install latest version from [code.visualstudio.com](https://code.visualstudio.com/download)
36+
2. Install "C/C++" And "CMake Tools" extensions inside **Visual Studio Code**
37+
38+
## 2. Install required packages
39+
40+
1. Run ```sudo apt-get update``` using **Terminal** app
41+
2. And ```sudo apt-get install git gcc g++ cmake```
42+
43+
44+
# macOS (Ventura 13)
45+
46+
## 1. Install Xcode (Or any other IDE)
47+
48+
1. Download and install latest version from **App Store** app
49+
2. Run ```xcode-select --install``` using **Terminal** app to install Xcode tools
50+
51+
## 2. Install required packages
52+
53+
1. Install **Homebrew** package manager from [brew.sh](https://brew.sh)
54+
2. Run ```brew update``` using **Terminal** app
55+
3. And ```brew install git cmake```
56+
57+
58+
# Build Project
59+
60+
To build the project run one of the [scripts](scripts/) using **Terminal**, **Git Bash** or build it using **IDE**.
61+
62+
## Visual Studio (2022)
63+
64+
1. Open **Visual Studio 2022** IDE
65+
2. Click "Open a local folder" and open the repository folder
66+
3. Click **Build -> Build All** to build the project
67+
68+
## Visual Studio Code (VS Code)
69+
70+
1. Open **Visual Studio Code** IDE
71+
2. Install "C/C++" And "CMake Tools" extensions
72+
3. Click **File -> Open Folder...** and open the repository folder
73+
4. Click **Yes** in "Would you like to configure project..."
74+
5. Select one of the compiler **Kits** in the opened window
75+
6. Click **Build** button at the bottom bar to build the engine

CMakeLists.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright 2021-2023 Nikita Fediuchin. All rights reserved.
1+
# Copyright 2021-2024 Nikita Fediuchin. All rights reserved.
22
#
33
# Licensed under the Apache License, Version 2.0 (the "License");
44
# you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ option(CONF_BUILD_SHARED "Build Conf shared library" ON)
3434
option(CONF_BUILD_TESTS "Build Conf library tests" ON)
3535

3636
set(MPIO_BUILD_SHARED OFF CACHE BOOL "" FORCE)
37+
set(MPIO_BUILD_TESTS OFF CACHE BOOL "" FORCE)
3738
add_subdirectory(libraries/mpio)
3839

3940
configure_file(cmake/defines.h.in include/conf/defines.h)

0 commit comments

Comments
 (0)