Merge branch 'improve-first-time-setup' of git://github.com/stefnotch/FlaxEngine into stefnotch-improve-first-time-setup

CONTRIBUTING.md

@@ -18,6 +18,8 @@ Go check out our [Trello](https://trello.com/b/NQjLXRCP/flax-roadmap).
 
 ## **Want to contribute?**
   
+* Fork the FlaxEngine, create a new branch and push your changes there. Then, create a pull request.
+  
 * When creating a PR for fixing an issue/bug make sure to describe as to what led to the fix for better understanding, for small and obvious fixes this is not really needed. 
   However make sure to mention the relevant issue where it was first reported if possible.
   

Development/Scripts/Linux/CallBuildTool.sh

@@ -3,6 +3,12 @@
 
 set -e
 
+testfilesize=$(wc -c < 'Source/Logo.png')
+if [ $testfilesize -le 1000 ]; then
+    echo "CallBuildTool ERROR: Repository was not cloned using Git LFS" 1>&2
+	exit 1
+fi
+
 # Compile the build tool.
 xbuild /nologo /verbosity:quiet "Source/Tools/Flax.Build/Flax.Build.csproj" /property:Configuration=Release /property:Platform=AnyCPU /target:Build
 

Development/Scripts/Windows/CallBuildTool.bat

@@ -4,6 +4,10 @@ rem Copyright (c) 2012-2020 Wojciech Figat. All rights reserved.
 
 if not exist "Development\Scripts\Windows\GetMSBuildPath.bat" goto Error_InvalidLocation
 
+for %%I in (Source\Logo.png) do if %%~zI LSS 2000 (
+	goto Error_MissingLFS
+)
+
 call "Development\Scripts\Windows\GetMSBuildPath.bat"
 if errorlevel 1 goto Error_NoVisualStudioEnvironment
 
@@ -33,6 +37,9 @@ Binaries\Tools\Flax.Build.exe %*
 if errorlevel 1 goto Error_FlaxBuildFailed
 exit /B 0
 
+:Error_MissingLFS
+echo CallBuildTool ERROR: Repository was not cloned using Git LFS
+goto Exit
 :Error_InvalidLocation
 echo CallBuildTool ERROR: The script is in invalid directory.
 goto Exit

GenerateProjectFiles.bat

@@ -16,6 +16,7 @@ exit /B 0
 
 :BuildToolFailed
 echo Flax.Build tool failed.
+pause
 goto Exit
 
 :Exit

README.md

@@ -26,6 +26,10 @@ This repository contains full source code of the Flax (excluding NDA-protected p
 
 Follow the instructions below to compile and run the engine from source.
 
+## Flax plugin for Visual Studio
+
+Flax Visual Studio extension provides better programming workflow, C# scripts debugging functionality and allows to attach to running engine instance to debug C# source. This extension is available to download [here](https://marketplace.visualstudio.com/items?itemName=Flax.FlaxVS).
+
 ## Windows
 
 * Install Visual Studio 2015 or newer
@@ -34,7 +38,8 @@ Follow the instructions below to compile and run the engine from source.
 * Clone repo (with LFS)
 * Run **GenerateProjectFiles.bat**
 * Open `Flax.sln` and set solution configuration to **Editor.Development** and solution platform to **Win64**
-* Compile Flax project (hit F7 key)
+* Set Flax or FlaxEngine as startup project
+* Compile Flax project (hit F7 or CTRL+Shift+B)
 * Run Flax (hit F5 key)
 
 ## Linux
@@ -49,10 +54,6 @@ Follow the instructions below to compile and run the engine from source.
 * Open workspace with Visual Code
 * Build and run
 
-# Flax plugin for Visual Studio
-
-Flax Visual Studio extension provides better programming workflow, C# scripts debugging functionality and allows to attach to running engine instance to debug C# source. This extension is available to download [here](https://marketplace.visualstudio.com/items?itemName=Flax.FlaxVS).
-
 ## Workspace directory
 
 - **Binaries/** - executable files