Skip to content

Commit

Permalink
[Docs] Extend prereq and building guidelines (stride3d#670)
Browse files Browse the repository at this point in the history
  • Loading branch information
Eideren authored Apr 26, 2020
1 parent 8099a9c commit c7ce12b
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Welcome to the Stride source code repository!

Stride is an open-source C# game engine for realistic rendering and VR.
The engine is highly modular and aims at giving game makers more flexibility in their development.
Stride comes with an editor that allows you create and manage the content of your games or applications in a visual and intuitive way.
Stride comes with an editor that allows you to create and manage the content of your games or applications visually and intuitively.

![Stride Editor](https://stride3d.net/images/external/script-editor.png)

To learn more about Stride, visit [stride3d.net](https://stride3d.net/).

## License

Stride is covered by [MIT](LICENSE.md), unless stated otherwise (i.e. for some files that are copied from other projects).
Stride is covered by the [MIT License](LICENSE.md) unless stated otherwise (i.e. for some files that are copied from other projects).

You can find the list of third party projects [here](THIRD%20PARTY.md).

Expand All @@ -40,7 +40,7 @@ Ask for help or report issues:

### Prerequisites

1. [Git](https://git-scm.com/downloads) (recent version that includes LFS, or install [Git LFS](https://git-lfs.github.com/) separately).
1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog.
2. [Visual Studio 2019](https://www.visualstudio.com/downloads/) with the following workloads:
* `.NET desktop development` with `.NET Framework 4.7.2 targeting pack`
* `Desktop development with C++` with
Expand All @@ -53,14 +53,20 @@ Ask for help or report issues:
* `MSVC v142 - VS2019 C++ ARM build tools (v14.23)` or later version (should be enabled by default)
* `MSVC v142 - VS2019 C++ ARM Spectre-mitigated libs (v14.23)` or later version (should be enabled by default)
* Optional (to target iOS/Android): `Mobile development with .NET` and `Android SDK setup (API level 27)` individual component, then in Visual Studio go to `Tools > Android > Android SDK Manager` and install `NDK` (version 19+) from `Tools` tab.
3. [FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)
3. **[FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)**

### Build Stride

1. Clone Stride: `git clone https://github.com/stride3d/stride.git`
2. Open `<StrideDir>\build\Stride.sln` with Visual Studio 2019, and build.
3. Open `<StrideDir>\samples\StrideSamples.sln` and play with the samples.
4. Optionally, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc...
1. Open a command prompt, point it to a directory and clone Stride to it: `git clone https://github.com/stride3d/stride.git`
2. Open `<StrideDir>\build\Stride.sln` with Visual Studio 2019 and build `Stride.GameStudio` (it should be the default startup project) or run it from VS's toolbar.
* Optionally, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.

If building failed:
* If you skipped one of the `Prerequisites` thinking that you already have the latest version, update to the latest anyway just to be sure.
* Visual Studio might have issues properly building if an outdated version of 2017 is present alongside 2019. If you want to keep VS 2017 make sure that it is up to date and that you are building Stride through VS 2019.
* Some changes might require a system reboot, try that if you haven't yet.

Do note that test solutions might fail but it should not prevent you from building `Stride.GameStudio`.

### Contribution Guidelines

Expand Down

0 comments on commit c7ce12b

Please sign in to comment.