mirror of
https://github.com/storytold/designcraft.git
synced 2026-10-27 11:46:51 -06:00
docs: add user docs for DesignCraft
Baseline user docs in docs/user/ (published at getartcraft.com/docs/designcraft), the docs-check and docs-publish workflows, and a "User docs" rule in AGENTS.md. Source notes per page: - index.md: README (intro, features, license), website crafting-apps.ts entry. - getting-started/index.md: crates/ui-egui/src/chrome.rs start_screen buttons. - getting-started/install.md: README Downloads, gh release view v0.6.0 asset list, packaging/windows/designcraft.wxs (Start Menu shortcut), launcher catalog.rs. - guides/create-a-document.md: dialogs.rs newDocument dialog, build.rs PRESETS, menus.rs UI_COMMANDS, chrome.rs start screen. - guides/open-a-file.md: apps/designcraft main.rs open_filters, engine file.rs and interchange.rs docs, lib.rs import warnings test, issue #110. - guides/place-images-and-text.md: main.rs place filters, engine file.rs file.place, dialogs.rs pdfImport, menus.rs placeWithOptions, release notes (#80). - guides/export-a-pdf.md: dialogs.rs pdf_export and apply_pdf_preset, menus.rs. - troubleshooting/app-closes-at-start.md: README graphics backend and logs, apps/designcraft/src/gpu.rs, issues #167, #192, #220, #273. - troubleshooting/get-help.md: README Logs section. - faq/is-it-free.md: README, docs/gaps.md. faq/supported-systems.md: README, release assets. faq/indesign-files.md: main.rs open filters, issues #450, #451, #110. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5.5
parent
f70f93de44
commit
2dca7e220e
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Get started
|
||||
description: Install DesignCraft, then open the sample magazine or start a new document.
|
||||
order: 10
|
||||
verified: 0.6.0
|
||||
---
|
||||
|
||||
Install DesignCraft first, then start a document.
|
||||
|
||||
1. [Install DesignCraft](install.md) on Windows 11, macOS or Linux.
|
||||
2. Open DesignCraft. The start screen has three buttons: **New file**, **Open** and **Open sample magazine**.
|
||||
3. Click **Open sample magazine** to see a finished layout, or follow [Create a new document](../guides/create-a-document.md) to begin your own.
|
||||
|
||||
DesignCraft also runs in a web browser. See [Which systems does DesignCraft run on?](../faq/supported-systems.md).
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Install DesignCraft
|
||||
description: Download DesignCraft 0.6.0 for Windows 11, macOS or Linux, or install it from ArtCraft Launcher.
|
||||
order: 20
|
||||
verified: 0.6.0
|
||||
---
|
||||
|
||||
Download the file for your system from the [latest release](https://github.com/storytold/designcraft/releases/latest) and install it. In the file names, `<ver>` stands for the version number, for example `0.6.0`. The release also has `SHA256SUMS.txt`, which lists a checksum for every file. The [DesignCraft page on getartcraft.com](https://getartcraft.com/apps/designcraft) links to the download as well.
|
||||
|
||||
## Windows 11
|
||||
|
||||
1. Open the [latest release](https://github.com/storytold/designcraft/releases/latest).
|
||||
2. Download `designcraft-<ver>-windows-x64.msi`. It fits most PCs (64-bit Intel and AMD).
|
||||
3. Run the file and follow the installer.
|
||||
4. Start **DesignCraft** from the Start menu.
|
||||
|
||||
The release also has an `arm64` installer for ARM PCs such as Snapdragon, and an `x86` installer for 32-bit Windows. To run without installing, download `designcraft-<ver>-windows-x64-portable.zip` (or the `arm64` or `x86` version), unzip it and start the program inside. The installers and executables are code-signed.
|
||||
|
||||
## macOS
|
||||
|
||||
1. Download `designcraft-<ver>-macos-universal.dmg`. It works on Apple silicon and Intel Macs.
|
||||
2. Open it and drag DesignCraft to Applications.
|
||||
|
||||
The app is signed and notarized.
|
||||
|
||||
## Linux
|
||||
|
||||
Pick one file from the release. Replace `x86_64` with `aarch64` on ARM.
|
||||
|
||||
| File | Notes |
|
||||
|-------------------------------------------|----------------------------------------------------------|
|
||||
| `designcraft-<ver>-linux-x86_64.AppImage` | Runs anywhere. |
|
||||
| `designcraft-<ver>-linux-x86_64.flatpak` | Sandboxed. Install with `flatpak install --user <file>`. |
|
||||
| `designcraft-<ver>-linux-x86_64.deb` | Debian and Ubuntu. |
|
||||
| `designcraft-<ver>-linux-x86_64.rpm` | Fedora, RHEL and openSUSE. |
|
||||
| `designcraft-<ver>-linux-x86_64.tar.gz` | Unpack anywhere. |
|
||||
|
||||
For RISC-V there is only `designcraft-<ver>-linux-riscv64.tar.gz`. It needs glibc 2.39 or newer (Ubuntu 24.04 or newer). A FreeBSD build (`designcraft-<ver>-freebsd-x86_64.tar.gz`) is on the release page too.
|
||||
|
||||
## Install with ArtCraft Launcher
|
||||
|
||||
ArtCraft Launcher lists DesignCraft and can install and update it for you. See [ArtCraft Launcher](https://getartcraft.com/docs/craft-launcher) for how it works.
|
||||
|
||||
## First run
|
||||
|
||||
Open DesignCraft. You land on the start screen. Continue with [Get started](index.md). If the window closes right away, see [DesignCraft closes right after it starts](../troubleshooting/app-closes-at-start.md).
|
||||
Reference in New Issue
Block a user