Skip to content

Commit fe2418f

Browse files
committed
update build instructions in the readme
1 parent 2d83d8c commit fe2418f

1 file changed

Lines changed: 11 additions & 19 deletions

File tree

README.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,27 @@ docker run -it memgraph/mgconsole:latest
2323
## Building and installing
2424

2525
To build and install mgconsole from source you will need:
26-
- CMake version >= 3.4
26+
- CMake version >= 3.10
2727
- OpenSSL version >= 1.0.2
2828
- C compiler supporting C11
2929
- C++ compiler supporting C++20
3030

3131
To install compile dependencies on Debian / Ubuntu:
3232

3333
```
34-
apt-get install -y git cmake make gcc g++ libssl-dev
34+
apt-get install -y git cmake make gcc g++ libssl-dev ninja-build
3535
```
3636

3737
On RedHat / CentOS / Fedora:
3838

3939
```
40-
yum install -y git cmake make gcc gcc-c++ openssl-devel libstdc++-static
40+
yum install -y git cmake make gcc gcc-c++ openssl-devel libstdc++-static ninja-build
4141
```
4242

4343
On MacOS, first make sure you have [XCode](https://developer.apple.com/xcode/) and [Homebrew](https://brew.sh) installed. Then, in the terminal, paste:
4444

4545
```
46-
brew install git cmake make openssl
46+
brew install git cmake make openssl ninja
4747
```
4848

4949
On Windows, you need to install the MSYS2. Just follow the [instructions](https://www.msys2.org), up to step 6.
@@ -59,39 +59,31 @@ inside the MSYS2 MINGW64 terminal:
5959
pacman -Syu --needed base-devel git mingw-w64-x86_64-toolchain mingw-w64-x86_64-cmake mingw-w64-x86_64-openssl
6060
```
6161

62-
Once everything is in place, create a build directory inside the source
63-
directory and configure the build by running CMake from it as follows:
62+
Once everything is in place, configure the build by running CMake as follows:
6463

6564
* on Linux:
6665
```
67-
mkdir build
68-
cd build
69-
cmake -DCMAKE_BUILD_TYPE=Release ..
66+
cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release .
7067
```
7168

7269
* on MacOS:
7370
```
74-
mkdir build
75-
cd build
76-
cmake -DOPENSSL_ROOT_DIR="$(brew --prefix openssl)" -DCMAKE_BUILD_TYPE=Release ..
71+
cmake -B build -G Ninja -DOPENSSL_ROOT_DIR="$(brew --prefix openssl)" -DCMAKE_BUILD_TYPE=Release .
7772
```
7873

7974
* on Windows, from the MSYS2 MINGW64 terminal:
8075
```
81-
mkdir build
82-
cd build
83-
cmake -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release ..
76+
cmake -B build -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Release .
8477
```
8578

86-
After running CMake, you should see a Makefile in the build directory. Then you
87-
can build the project by running:
79+
After running CMake, you can build the project by running:
8880
```
89-
make
81+
cmake --build build
9082
```
9183

9284
This will build the `mgconsole` binary. To install it, run:
9385
```
94-
make install
86+
cmake --install build
9587
```
9688

9789
This will install to system default installation directory. If you want to

0 commit comments

Comments
 (0)