Windows getting started docs with stepforge example

2026-06-23 12:10:42 -05:00
parent d607905b58
commit 7fe30cf8ef
12 changed files with 106 additions and 0 deletions
@@ -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:
@@ -0,0 +1,100 @@
+# Windows_installation
+
+<div style="height:4px;background:#2563eb;border-radius:999px;margin:12px 0 18px;"></div>
+
+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)
+
+<a id="step-1"></a>
+
+## 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)
+
+<a id="step-1-1"></a>
+
+### 1.1. Click on releases
+
+![Step 1.1](steps-windows_installation/002-click-on-releases.png)
+
+<a id="step-1-1-1"></a>
+
+### 1.1.1. Select the latest release for StepForge
+
+![Step 1.1.1](steps-windows_installation/003-select-the-latest-release-for-stepforge.png)
+
+<div class="sf-callout sf-callout-note" style="border-left: 4px solid #2563eb; padding: 14px 16px; margin: 14px 0; border-radius: 0 16px 16px 0;">
+<div style="font-weight: 700; color: #1d4ed8; margin-bottom: 6px;">Note: Newest version</div>
+<div style="color: inherit;"><p>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.</p></div>
+</div>
+
+<a id="step-2"></a>
+
+## 2. Run the installer.
+
+![Step 2](steps-windows_installation/004-run-the-installer..png)
+
+<a id="step-2-1"></a>
+
+### 2.1. Click More Info
+
+![Step 2.1](steps-windows_installation/005-click-more-info.png)
+
+<div class="sf-callout sf-callout-important" style="border-left: 4px solid #ef4444; padding: 14px 16px; margin: 14px 0; border-radius: 0 16px 16px 0;">
+<div style="font-weight: 700; color: #b91c1c; margin-bottom: 6px;">Important: Select More Info</div>
+<div style="color: inherit;"><p>Windows is warning you because this installer is new and hasn’t built up enough Microsoft SmartScreen reputation yet.</p></div>
+</div>
+
+<a id="step-2-1-1"></a>
+
+### 2.1.1. Select Run anyway
+
+![Step 2.1.1](steps-windows_installation/006-select-run-anyway.png)
+
+<a id="step-2-2"></a>
+
+### 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)
+
+<a id="step-2-3"></a>
+
+### 2.3. Select next
+
+![Step 2.3](steps-windows_installation/008-select-next.png)
+
+<a id="step-2-4"></a>
+
+### 2.4. Select install
+
+![Step 2.4](steps-windows_installation/009-select-install.png)
+
+<a id="step-2-5"></a>
+
+### 2.5. Select Finish
+
+![Step 2.5](steps-windows_installation/010-select-finish.png)
+
+<div class="sf-callout sf-callout-tip" style="border-left: 4px solid #10b981; padding: 14px 16px; margin: 14px 0; border-radius: 0 16px 16px 0;">
+<div style="font-weight: 700; color: #047857; margin-bottom: 6px;">Tip: You're finished!</div>
+<div style="color: inherit;"><p>Go ahead and play around with StepForge and make some docs!</p></div>
+</div>
+