Skip to content

Commit 8d761d5

Browse files
committed
Add dependencies info to readme
1 parent c033c60 commit 8d761d5

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ This project involves minimal implementations of the popular planning algorithms
1414
- to change starting cell (`left-SHIFT + left-CLICKED`)
1515
- to change end cell (`left-CTRL + left-CLICKED`)
1616

17+
## Dependencies
18+
19+
* cmake >= 3.14
20+
* All OSes: [click here for installation instructions](https://cmake.org/install/)
21+
* make >= 4.1 (Linux, Mac), 3.81 (Windows)
22+
* Linux: make is installed by default on most Linux distros
23+
* Mac: [install Xcode command line tools to get make](https://developer.apple.com/xcode/features/)
24+
* Windows: [Click here for installation instructions](http://gnuwin32.sourceforge.net/packages/make.htm)
25+
* gcc/g++ >= 5.4
26+
* Linux: gcc / g++ is installed by default on most Linux distros
27+
* Mac: same deal as make - [install Xcode command line tools](https://developer.apple.com/xcode/features/)
28+
* Windows: recommend using [MinGW](http://www.mingw.org/)
29+
1730
## Basic Build Instructions
1831

1932
The project depends on [SFML](https://github.com/SFML/SFML), [Dear ImGui](https://github.com/ocornut/imgui) and [ImGui-SFML](https://github.com/eliasdaler/imgui-sfml). However, you are not required to install external dependencies by yourself. The following build instructions will manage all the necessary external dependencies for you.

0 commit comments

Comments
 (0)