diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 15e69c3..206ec6c 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -3,6 +3,12 @@ StepForge is a fully offline desktop app. Nothing is uploaded or synced, and all guides stay on your machine. +# Windows installation + +For the windows installation, please see [windows_installation](windows_installation.md) + +# Developer install + ## 1. Install From the repository root: diff --git a/docs/steps-windows_installation/001-navigate-to-the-git-repo..png b/docs/steps-windows_installation/001-navigate-to-the-git-repo..png new file mode 100644 index 0000000..e0e45d6 Binary files /dev/null and b/docs/steps-windows_installation/001-navigate-to-the-git-repo..png differ diff --git a/docs/steps-windows_installation/002-click-on-releases.png b/docs/steps-windows_installation/002-click-on-releases.png new file mode 100644 index 0000000..97730b8 Binary files /dev/null and b/docs/steps-windows_installation/002-click-on-releases.png differ diff --git a/docs/steps-windows_installation/003-select-the-latest-release-for-stepforge.png b/docs/steps-windows_installation/003-select-the-latest-release-for-stepforge.png new file mode 100644 index 0000000..334191f Binary files /dev/null and b/docs/steps-windows_installation/003-select-the-latest-release-for-stepforge.png differ diff --git a/docs/steps-windows_installation/004-run-the-installer..png b/docs/steps-windows_installation/004-run-the-installer..png new file mode 100644 index 0000000..5497b50 Binary files /dev/null and b/docs/steps-windows_installation/004-run-the-installer..png differ diff --git a/docs/steps-windows_installation/005-click-more-info.png b/docs/steps-windows_installation/005-click-more-info.png new file mode 100644 index 0000000..42b0c9c Binary files /dev/null and b/docs/steps-windows_installation/005-click-more-info.png differ diff --git a/docs/steps-windows_installation/006-select-run-anyway.png b/docs/steps-windows_installation/006-select-run-anyway.png new file mode 100644 index 0000000..28d279e Binary files /dev/null and b/docs/steps-windows_installation/006-select-run-anyway.png differ diff --git a/docs/steps-windows_installation/007-select-install-for-me-or-install-for-all-users.png b/docs/steps-windows_installation/007-select-install-for-me-or-install-for-all-users.png new file mode 100644 index 0000000..26cee2e Binary files /dev/null and b/docs/steps-windows_installation/007-select-install-for-me-or-install-for-all-users.png differ diff --git a/docs/steps-windows_installation/008-select-next.png b/docs/steps-windows_installation/008-select-next.png new file mode 100644 index 0000000..793c991 Binary files /dev/null and b/docs/steps-windows_installation/008-select-next.png differ diff --git a/docs/steps-windows_installation/009-select-install.png b/docs/steps-windows_installation/009-select-install.png new file mode 100644 index 0000000..6831450 Binary files /dev/null and b/docs/steps-windows_installation/009-select-install.png differ diff --git a/docs/steps-windows_installation/010-select-finish.png b/docs/steps-windows_installation/010-select-finish.png new file mode 100644 index 0000000..ec09117 Binary files /dev/null and b/docs/steps-windows_installation/010-select-finish.png differ diff --git a/docs/windows_installation.md b/docs/windows_installation.md new file mode 100644 index 0000000..d84fb7a --- /dev/null +++ b/docs/windows_installation.md @@ -0,0 +1,100 @@ +# Windows_installation + +
+ +Author: Tyler Westbrook + +*10 steps · generated 2026-06-23* + +Welcome to StepForge the easy documentation writer! This guide shows you how to setup StepForge on your windows computer step by step. As a demo of this project, this guide was 100% made with StepForge with no outside editing. Enjoy! + +## Contents + +- [1. Navigate to the git repo.](#step-1) + - [1.1. Click on releases](#step-1-1) + - [1.1.1. Select the latest release for StepForge](#step-1-1-1) +- [2. Run the installer.](#step-2) + - [2.1. Click More Info](#step-2-1) + - [2.1.1. Select Run anyway](#step-2-1-1) + - [2.2. Select install for me or install for all users](#step-2-2) + - [2.3. Select next](#step-2-3) + - [2.4. Select install](#step-2-4) + - [2.5. Select Finish](#step-2-5) + + + +## 1. Navigate to the git repo. + +Navigate to the [Github Repository](https://github.com/Twest2/StepForge) located in the link. + +![Step 1](steps-windows_installation/001-navigate-to-the-git-repo..png) + + + +### 1.1. Click on releases + +![Step 1.1](steps-windows_installation/002-click-on-releases.png) + + + +### 1.1.1. Select the latest release for StepForge + +![Step 1.1.1](steps-windows_installation/003-select-the-latest-release-for-stepforge.png) + +
+
Note: Newest version
+

Please make sure you select the newest version of StepForge, not v0.2.0. The .exe is an installer that will install the program for you.

+
+ + + +## 2. Run the installer. + +![Step 2](steps-windows_installation/004-run-the-installer..png) + + + +### 2.1. Click More Info + +![Step 2.1](steps-windows_installation/005-click-more-info.png) + +
+
Important: Select More Info
+

Windows is warning you because this installer is new and hasn’t built up enough Microsoft SmartScreen reputation yet.

+
+ + + +### 2.1.1. Select Run anyway + +![Step 2.1.1](steps-windows_installation/006-select-run-anyway.png) + + + +### 2.2. Select install for me or install for all users + +![Step 2.2](steps-windows_installation/007-select-install-for-me-or-install-for-all-users.png) + + + +### 2.3. Select next + +![Step 2.3](steps-windows_installation/008-select-next.png) + + + +### 2.4. Select install + +![Step 2.4](steps-windows_installation/009-select-install.png) + + + +### 2.5. Select Finish + +![Step 2.5](steps-windows_installation/010-select-finish.png) + +
+
Tip: You're finished!
+

Go ahead and play around with StepForge and make some docs!

+
+