diff --git a/README.md b/README.md index f15bff15..1661ac9b 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,30 @@ dreavm is a work in progress emulator for the SEGA Dreamcast.

-## Building +## Getting started +Start by cloning the repository and setting up a build directory. ```shell git clone https://github.com/inolen/dreavm.git mkdir dreavm_build cd dreavm_build -cmake ../dreavm -cmake --build . ``` -The build has been tested on OSX 10.10 with clang 3.6 and Ubuntu 14.04 with GCC 4.9. GCC 4.8 had C++11 related issues preventing it from compiling. +Next, generate a makefile or project file for your IDE of choice. For more info on the supported IDEs, checkout the [CMake documentation](http://www.cmake.org/cmake/help/latest/manual/cmake-generators.7.html). +```shell +# Makefile +cmake ../dreavm + +# Xcode project +cmake -G "Xcode" ../dreavm + +# Visual Studio project +cmake -G "Visual Studio 14 Win64" ../dreavm +``` + +Finally, you can either run `make` from the command line if you've generated a Makefile or load up the project file and compile the code from inside of your IDE. + +The build has been tested on OSX 10.10 with clang 3.6, Ubuntu 14.04 with GCC 4.9 and Windows 8.1 with Visual Studio 2015. ## Running ```