summaryrefslogtreecommitdiff
path: root/docs/technical/smapi.md
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-04-29 22:55:12 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2022-04-29 22:55:12 -0400
commitf507bd0f9cebe68fa2adf176740a0d00b3e6f884 (patch)
tree67a7653f14ad0140ec705988d1bdb836b7bb5b3d /docs/technical/smapi.md
parenta340c8b8ce8cf0c3b218162117cbc2e8f5acb2b8 (diff)
downloadSMAPI-f507bd0f9cebe68fa2adf176740a0d00b3e6f884.tar.gz
SMAPI-f507bd0f9cebe68fa2adf176740a0d00b3e6f884.tar.bz2
SMAPI-f507bd0f9cebe68fa2adf176740a0d00b3e6f884.zip
set SMAPI version from main build script
Diffstat (limited to 'docs/technical/smapi.md')
-rw-r--r--docs/technical/smapi.md22
1 files changed, 10 insertions, 12 deletions
diff --git a/docs/technical/smapi.md b/docs/technical/smapi.md
index 789ea20b..4d75aef2 100644
--- a/docs/technical/smapi.md
+++ b/docs/technical/smapi.md
@@ -120,8 +120,10 @@ Windows](#on-windows)_ section below to create a build that retains the icon.**
2. Launch the game through the Steam UI.
### Prepare the release
-1. Run `build/unix/set-smapi-version.sh` to set the SMAPI version. Make sure you use a [semantic
- version](https://semver.org). Recommended format:
+1. Run `build/unix/prepare-install-package.sh VERSION_HERE` to create the release package in the
+ root `bin` folder.
+
+ Make sure you use a [semantic version](https://semver.org). Recommended format:
build type | format | example
:--------- | :----------------------- | :------
@@ -129,9 +131,6 @@ Windows](#on-windows)_ section below to create a build that retains the icon.**
prerelease | `<version>-beta.<date>` | `4.0.0-beta.20251230`
release | `<version>` | `4.0.0`
-2. Run `build/unix/prepare-install-package.sh` to create the release package in the root `bin`
- folder.
-
### On Windows
#### First-time setup
1. Set up Windows Subsystem for Linux (WSL):
@@ -147,8 +146,10 @@ Windows](#on-windows)_ section below to create a build that retains the icon.**
```
### Prepare the release
-1. Run `build/windows/set-smapi-version.ps1` in PowerShell to set the SMAPI version. Make sure you
- use a [semantic version](https://semver.org). Recommended format:
+1. Run `build/windows/prepare-install-package.ps1 VERSION_HERE` in PowerShell to create the release
+ package folders in the root `bin` folder.
+
+ Make sure you use a [semantic version](https://semver.org). Recommended format:
build type | format | example
:--------- | :----------------------- | :------
@@ -156,12 +157,9 @@ Windows](#on-windows)_ section below to create a build that retains the icon.**
prerelease | `<version>-beta.<date>` | `4.0.0-beta.20251230`
release | `<version>` | `4.0.0`
-2. Run `build/windows/prepare-install-package.ps1` in PowerShell to create the release package
- folders in the root `bin` folder.
-
-3. Launch WSL and run this script:
+2. Launch WSL and run this script:
```bash
- # edit to match the build created in steps 1-2
+ # edit to match the build created in steps 1
# In WSL, `/mnt/c/example` accesses `C:\example` on the Windows filesystem.
version="4.0.0"
binFolder="/mnt/e/source/_Stardew/SMAPI/bin"