Tyler/StepForge
1
0
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

minor changes
Template tests / tests (push) Successful in 1m44s
Details

Browse Source
This commit is contained in:
Tyler
2026-06-23 16:26:13 -05:00
parent 4cbab15429
commit 2b27428849
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -5
View File
@@ -6,7 +6,7 @@ and describe each step in a focused three-pane editor, and exports the result
to Markdown, DOCX, PPTX, PDF, HTML (WIP), GIF (WIP), confluence (WIP), Wiki.js (WIP), and image bundles (WIP). The current reconmendations for exporting is Markdown and PDF. to Markdown, DOCX, PPTX, PDF, HTML (WIP), GIF (WIP), confluence (WIP), Wiki.js (WIP), and image bundles (WIP). The current reconmendations for exporting is Markdown and PDF.
It is an independent offline desktop guide-capture tool inspired by publicly It is an independent offline desktop guide-capture tool inspired by publicly
documented workflow patterns of commercial documentation tools. It contains no documented workflow patterns of commercial documentation tools like Folge. It contains no
third-party branding, assets, or code from those tools, and it never talks to third-party branding, assets, or code from those tools, and it never talks to
the network: no telemetry, no update checks, no license checks, no cloud, no the network: no telemetry, no update checks, no license checks, no cloud, no
remote AI. remote AI.
@@ -60,7 +60,7 @@ using only Node built-ins.
## Getting Started ## Getting Started
For a windows installation, see [docs/windows_installatin](docs/windows_installation.md) or for a developer/more in depth walkthrough, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md). For a windows installation, see [docs/windows_installation](docs/windows_installation.md) or for a developer/more in depth walkthrough, see [docs/GETTING_STARTED.md](docs/GETTING_STARTED.md).
Requirements: Node.js 20+ and npm (Electron is the only dependency). Requirements: Node.js 20+ and npm (Electron is the only dependency).
@@ -115,11 +115,12 @@ clean-room rules.
## Repository Layout ## Repository Layout
Project docs live in `docs/`, and prompt handoffs live in `ai_prompts/`. Project docs live in `docs/` and prompt handoffs live in `ai_prompts/`.
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the repo layout. See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the repo layout.
## License ## License
Application code is licensed under [MPL-2.0](LICENSE). Bundled example Creative Commons Attribution-NonCommercial
guides, templates, and screenshots are CC-BY-4.0 unless noted otherwise.
Basically, do whatever you want with it just don't make money off it or sell it.