building guide

Author: MattDHill

src/README.md

@@ -121,6 +121,7 @@ Here you will find everything you need to set up and use your Start9 server. For
 - [Environment Setup](packaging-guide/environment-setup.md)
 - [Quick Start](packaging-guide/quick-start.md)
 - [Project Structure](packaging-guide/project-structure.md)
+- [Building and Installing](packaging-guide/building.md)
 - [Important Info](packaging-guide/important-info.md)
 
 ### [❓ Help](help/)

src/SUMMARY.md

@@ -152,6 +152,7 @@
   - [Environment Setup](packaging-guide/environment-setup.md)
   - [Quick Start](packaging-guide/quick-start.md)
   - [Project Structure](packaging-guide/project-structure.md)
+  - [Building and Installing](packaging-guide/building.md)
   - [Important Info](packaging-guide/important-info.md)
 
 - [❓ Help](help/README.md)

src/packaging-guide/README.md

@@ -4,4 +4,5 @@
 - [Environment Setup](environment-setup.md)
 - [Quick Start](quick-start.md)
 - [Project Structure](project-structure.md)
+- [Building and Installing](building.md)
 - [Important Info](important-info.md)

src/packaging-guide/Makefile.md src/packaging-guide/building.mdsrc/packaging-guide/Makefile.md renamed to src/packaging-guide/building.md

@@ -1,18 +1,14 @@
-# Makefile
+# Building and Installing
 
-Makefile automates building, packaging, and installing StartOS services (.s9pk files) with support for multiple architectures and automatic JS/TS build steps.
-
-## Basic Usage
-
-### Default Build (Universal)
+## Default Build (Universal)
 
 ```
 make
 ```
 
 Builds a universal package supporting all platforms. Same as running `make all`.
 
-### Platform-Specific Builds
+## Platform-Specific Builds
 
 ```
 make aarch64   # Build for ARM64 (Raspberry Pi, etc.)
@@ -21,7 +17,7 @@ make x86_64    # Build for x86_64 architecture
 
 > **Note:** For convenience, legacy targets `make arm` and `make x86` are also supported as aliases for `aarch64` and `x86_64` respectively. Using the full architecture name is recommended for clarity.
 
-### Installation
+## Installing
 
 ```
 make install
@@ -30,7 +26,7 @@ make install
 Builds the package and installs it directly to your configured StartOS device.  
 Requires a valid `~/.startos/config.yaml` with a `host: http://<device>.local` entry.
 
-## Available Targets
+## Summary of Commands
 
 | Target               | Description                                                |
 | -------------------- | ---------------------------------------------------------- |
@@ -42,15 +38,15 @@ Requires a valid `~/.startos/config.yaml` with a `host: http://<device>.local` e
 
 ## Tandem Operations
 
-You can chain multiple targets:
+You can chain multiple commands:
 
 ```
-make clean aarch64          # Clean then build ARM64 package
+make clean aarch64          # Clean, then build ARM64 package
 make clean x86_64 install   # Clean, build x86_64 package, then install
 make clean install          # Clean, build universal, then install
 ```
 
-## Example Output
+## Example Outputs
 
 **Building aarch64 package:**
 
@@ -89,12 +85,3 @@ Sideloading 100% █████████████████████
 $ make clean
 Cleaning up build artifacts...
 ```
-
-## Prerequisites
-
-- [**start-cli**](https://github.com/start9labs/start-cli): StartOS development toolkit
-- **npm**: Node.js package manager
-- **`~/.startos/config.yaml`**: must contain your StartOS device host config
-- **Developer key**: If missing, `make` will auto-run `start-cli init`
-
-The Makefile automatically builds JavaScript from TypeScript (`npm run build`) and installs dependencies from `package.json` as needed.

src/packaging-guide/project-structure.md

@@ -16,9 +16,9 @@
 └── tsconfig.json
 ```
 
-#### .gitignore, [Makefile](./Makefile.md), package-lock.json, package.json, and tsconfig.json
+#### .gitignore, Makefile, package-lock.json, package.json, and tsconfig.json
 
-These are boilerplate files that need not be edited, except in special circumstances.
+These are boilerplate files that generally do not require editing.
 
 #### Dockerfile (optional)
 

src/packaging-guide/quick-start.md

@@ -36,24 +36,12 @@ cd [repository-name]
 npm i
 ```
 
-## Build the s9pk
-
-    make
-
-## Install the s9pk
-
-### From the CLI
-
-```
-start-cli install -h <host> -s <path-to-s9pk>
-```
-
-You can eliminate the `-h` argument by hard-coding the host in `~/.startos/config.yaml`. For example:
+## Build and Install your Package
 
 ```
-host: https://server-name.local
+make
 ```
 
-### From the GUI
+This produces a `[service-id].s9pk` at the root of your project that can be sideloaded through the StartOS UI.
 
-From the GUI of your StartOS server, go to `System > Sideload`, upload the .s9pk file, and click "Install".
+See [Building and Installing](./building.md) for more options and to streamline your development workflow.