You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,4 +32,22 @@ DocForge is a desktop application designed to streamline the process of creating
32
32
3.**Configure:** Launch DocForge, open the Settings view, and select your detected LLM service and a model to use for refinement tasks.
33
33
4.**Create:** Start creating, organizing, and refining your documents!
34
34
35
-
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
35
+
For detailed instructions on usage and features, please refer to the [Functional Manual](./FUNCTIONAL_MANUAL.md).
36
+
To review the history of changes, see the [Version Log](./VERSION_LOG.md).
37
+
38
+
## Release Preparation
39
+
40
+
To create a new public build of DocForge:
41
+
42
+
1. Update the version in `package.json` and regenerate the lockfile with `npm version <new-version> --no-git-tag-version`.
43
+
2. Review the Markdown documentation (README, manuals, and version log) so the release notes accurately reflect recent changes.
44
+
3. Sync the documentation copies under `docs/` (README, manuals, version log) with any updates made at the project root.
45
+
4. Run `npm run publish` to build the application and publish the artifacts to the configured GitHub release target via Electron Builder.
46
+
47
+
## Application Icon Workflow
48
+
49
+
- The canonical artwork lives at `assets/icon.svg`. Keep this SVG under version control to simplify brand updates.
50
+
-`npm run build` (and any script that calls it) automatically validates the SVG and regenerates `icon.icns`, `icon.ico`, and a high-resolution `icon.png` via the `scripts/prepare-icons.mjs` helper.
51
+
- If the SVG is missing or invalid the script logs a warning and leaves existing binary icons untouched, allowing packaging to proceed with the previously generated assets.
52
+
- Run `npm run prepare:icons` to regenerate the platform-specific icons on demand without rebuilding the JavaScript bundles.
0 commit comments