Browse Source

Various menu items trying out

JornosDekstop 2 years ago
parent
commit
2f50292be3

+ 3 - 0
en/contributors/documentation/contribute-documentation.md

@@ -0,0 +1,3 @@
+# Contribute to documentation
+
+https://github.com/stride3d/stride-docs/wiki 

+ 5 - 0
en/contributors/donate.md

@@ -0,0 +1,5 @@
+# Donating to Stride
+We gather funding through a website called OpenCollective. We believe that all money being donated should be traceable. Our incoming and expenses are listed on this website too.
+
+- Bug bounties
+- Projects

+ 47 - 0
en/contributors/engine/build-pipeline.md

@@ -0,0 +1,47 @@
+# Building the source to Stride engine
+
+??
+WIP: make a page that is refernced by the readme.md on Stride: https://github.com/stride3d/stride
+
+
+
+
+COPIED from readme.mdf.............
+
+## Prerequisites
+
+1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog.
+2. [DotNet SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+    - Run `dotnet --info` in a console or powershell window to see which versions you have installed
+3. [Visual Studio 2022](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
+        - `Windows 10 SDK (10.0.18362.0)` (it's currently enabled by default but it might change)
+        - `MSVC v143 - VS2022 C++ x64/x86 build tools (v14.30)` or later version (should be enabled by default)
+        - `C++/CLI support for v143 build tools (v14.30)` or later version **(not 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.
+4. **[FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)**
+
+## Build Stride
+
+1. Open a command prompt, point it to a directory and clone Stride to it: `git clone https://github.com/stride3d/stride.git`
+    - Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support ```lfs```, make sure you use the command above or that your git client does it for you
+2. Open `<StrideDir>\build\Stride.sln` with Visual Studio 2022 and build `Stride.GameStudio` in the 60-Editor solution folder (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.
+
+## Build Stride without Visual Studio
+
+1. Install [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed above
+2. Add MSBuild's directory to your system's *PATH* (ex: `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`)
+3. Open a command prompt, point it to a directory and clone Stride to it: `git lfs clone https://github.com/stride3d/stride.git`
+4. Navigate to `/Build` with the command prompt, input `msbuild /t:Restore Stride.sln` then `compile.bat`
+
+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 anterior version is present alongside 2022. If you want to keep those version make sure that they are up to date and that you are building Stride through VS 2022.
+* Your system's *PATH* should not contain older versions of MSBuild (ex: `...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` should be removed)
+* Some changes might require a system reboot, try that if you haven't yet.
+* Make sure that Git, Git LFS and Visual Studio can access the internet.
+* Close VS, clear the nuget cache (in your cmd `dotnet nuget locals all --clear`), delete the hidden `.vs` folder inside `\build` and the files inside `bin\packages`, kill any msbuild and other vs processes, build the whole solution then build and run GameStudio.
+
+Do note that test solutions might fail but it should not prevent you from building `Stride.GameStudio`.

+ 47 - 0
en/contributors/engine/building-the-source.md

@@ -0,0 +1,47 @@
+# Building the source to Stride engine
+
+??
+WIP: make a page that is refernced by the readme.md on Stride: https://github.com/stride3d/stride
+
+
+
+
+COPIED from readme.mdf.............
+
+## Prerequisites
+
+1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog.
+2. [DotNet SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+    - Run `dotnet --info` in a console or powershell window to see which versions you have installed
+3. [Visual Studio 2022](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
+        - `Windows 10 SDK (10.0.18362.0)` (it's currently enabled by default but it might change)
+        - `MSVC v143 - VS2022 C++ x64/x86 build tools (v14.30)` or later version (should be enabled by default)
+        - `C++/CLI support for v143 build tools (v14.30)` or later version **(not 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.
+4. **[FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)**
+
+## Build Stride
+
+1. Open a command prompt, point it to a directory and clone Stride to it: `git clone https://github.com/stride3d/stride.git`
+    - Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support ```lfs```, make sure you use the command above or that your git client does it for you
+2. Open `<StrideDir>\build\Stride.sln` with Visual Studio 2022 and build `Stride.GameStudio` in the 60-Editor solution folder (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.
+
+## Build Stride without Visual Studio
+
+1. Install [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed above
+2. Add MSBuild's directory to your system's *PATH* (ex: `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`)
+3. Open a command prompt, point it to a directory and clone Stride to it: `git lfs clone https://github.com/stride3d/stride.git`
+4. Navigate to `/Build` with the command prompt, input `msbuild /t:Restore Stride.sln` then `compile.bat`
+
+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 anterior version is present alongside 2022. If you want to keep those version make sure that they are up to date and that you are building Stride through VS 2022.
+* Your system's *PATH* should not contain older versions of MSBuild (ex: `...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` should be removed)
+* Some changes might require a system reboot, try that if you haven't yet.
+* Make sure that Git, Git LFS and Visual Studio can access the internet.
+* Close VS, clear the nuget cache (in your cmd `dotnet nuget locals all --clear`), delete the hidden `.vs` folder inside `\build` and the files inside `bin\packages`, kill any msbuild and other vs processes, build the whole solution then build and run GameStudio.
+
+Do note that test solutions might fail but it should not prevent you from building `Stride.GameStudio`.

+ 1 - 0
en/contributors/engine/contribute-engine.md

@@ -0,0 +1 @@
+# Contribute to Stride engine

+ 20 - 4
en/contributors/toc.md

@@ -1,4 +1,20 @@
-# [Ways to contribute](ways-to-contribute.md)
-## [Contributing to the engine](engine/contribute-engine.md)
-## [Contributing to documentation](contribute-documentation.md)
-## [Contributing to the website](contribute-website.md)
+- name: 🌟 Contributors
+  href: ways-to-contribute.md
+- name: 💸 Donate
+  href: donate.md
+- name: 🛠️ Stride engine
+  expanded: false
+  href: engine/contribute-engine.md
+  items:
+  - name: Building source
+    href: building-source.md
+  - name: Build pipeline
+    href: build-pipeline.md
+- name: 🛠️ Stride documentation
+  expanded: false
+  href: contribute-documentation.md
+- name: 🛠️ Stride website
+  expanded: false
+  href: contribute-website.md
+
+

+ 2 - 2
en/contributors/ways-to-contribute.md

@@ -24,9 +24,9 @@ Making Stride more stable greatly improves usability and user satisfaction. So i
 Contributing to Pull Requests (PRs) is excellent as it enables active participation without local builds. Reviewing and offering feedback in this collaborative process enhances code quality and maintains project standards, fostering a sense of community and knowledge sharing.
 
 
-### [Contribute code](contribute-code.md)
+### [Contribute code](engine/contribute-engine.md)
 If you're passionate about C# and want to contribute by building features or fixing bugs in Stride, dive into the source code and get involved!
 Have a look at the Github issues label [Good first issue](https://github.com/stride3d/stride/labels/good%20first%20issue).
 
-### [Contribute to Documentation](contribute-documentation.md)
+### [Contribute to Documentation](documentation/contribute-documentation.md)
 Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.

+ 3 - 0
en/contributors/website/contribute-website.md

@@ -0,0 +1,3 @@
+# Contribute to website
+
+https://github.com/stride3d/stride-website/wiki 

+ 1 - 4
en/index.md

@@ -2,9 +2,6 @@
 
 Welcome to the Stride documentation, specifically designed for game developers, visual creators, and all users of the powerful [Stride game engine](https://www.stride3d.net/). This resource is packed with detailed tutorials, in-depth manuals, and comprehensive API references to help you bring your game development visions to life with Stride. Whether you're new to Stride or looking to hone your skills, you'll find everything you need right here. Dive in, and let's create something extraordinary!
 
-> [!TIP]
-> This documentation is primarily for users of the Stride engine. If you are interested in contributing to the Stride engine code base, please follow the [Stride contribution instructions](https://github.com/stride3d/stride).
-
 <div class="row g-4 mb-4">
     <div class="col-md-6">
         <div class="card h-100">
@@ -39,7 +36,7 @@ Welcome to the Stride documentation, specifically designed for game developers,
                 <h2 class="card-title h5">🌟 Contributors</h2>
                 <p class="card-text">Learn how you can contribute to Stride's development.</p>
             </div>
-            <p class="px-3 mb-4"><a class="stretched-link" href="contributors/index.md">Start contributing to Stride</a></p>
+            <p class="px-3 mb-4"><a class="stretched-link" href="contributors/ways-to-contribute.md">Start contributing to Stride</a></p>
         </div>
     </div>
     <div class="col-md-6">

+ 1 - 1
en/toc.yml

@@ -15,7 +15,7 @@
 - name: 📝 Release Notes
   href: ReleaseNotes/ReleaseNotes.md
 - name: 🌟 Contributing
-  href: contributors/index.md
+  href: contributors/ways-to-contribute.md
 - name: 🔧 API
   href: api/
   homepage: api/index.md