Compare commits

..

1 Commits

Author SHA1 Message Date
4b24be1886 Readme Created
Start of the Readme, documents what is required to start working on the project.
2026-04-03 22:34:46 -04:00

View File

@@ -7,7 +7,7 @@ Index:
## Getting Started
Working on this project requires some things that you need to install. Those being
Working on this project requires some things you need to install. Those being
Visual Studio, S&box, Git (LFS enabled). Among that you will need access to the
[Gitea](https://gitea.vps.collinssoft.com). You'll know who to reach out to
if you are lacking access. This will only target Windows development since
@@ -42,10 +42,10 @@ for all developers to gain access, and this documentation will be updated.
#### 3.) Install Visual Studio
Installing Visual Studio is a similar process to installing Git but with some UI
Installing Visual Studio is similar process to installing Git but with some UI
elements added. To start download the installer from [Microslop](https://visualstudio.microsoft.com/downloads/?utm_medium=microsoft&utm_source=learn.microsoft.com&utm_campaign=inline+link&0utm_content=download+vs2026+desktopguide+winforms).
Once you run the installer, you should see something similar to this:
Once you run the installer, you should something similar to this:
![microslop-feature-selection](./Docs/Img/windows-vs-feature-selection.png)
@@ -81,7 +81,7 @@ Opening up S&Box you should see the project selector pop up.
In the picutre you can see an arrow pointing to a button, clicking
that button will open up the explorer. Traverse to the project root
and click Open. After that you should have the project appear as a
selectable option afterwards. Click that and it will open the S&Box editor and
selectable option. Click that and it will open the S&Box editor and
now you can start working on the project.
*NOTE: Make sure that you have started the project with S&Box it will
@@ -90,7 +90,8 @@ step.*
#### 6.) Add the Project to Visual Studio
The last step is to configure Visual Studio.
The last step is to configure Visual Studio, and much like the last step
is to configure Visual Studio to the path of the project.
![visual-studio-project-selector](./Docs/Img/visual-studio-project-selector.png)