### Install Lore and start a local server on Windows Source: https://epicgames.github.io/lore/tutorials/quickstart?q= Set the LORE_DEMO environment variable and execute the PowerShell install script to download binaries and start the server. ```powershell $env:LORE_DEMO=1; irm https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.ps1 | iex ``` -------------------------------- ### Install Lore and start a local server on macOS / Linux Source: https://epicgames.github.io/lore/tutorials/quickstart?q= Run the install script in demo mode to download prebuilt binaries and start a local server instance. ```bash curl -fsSL https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.sh | bash -s -- --demo ``` -------------------------------- ### Install Lore and start a local server (macOS/Linux and Windows) Source: https://epicgames.github.io/lore/tutorials/quickstart Install the Lore CLI and start a local server in demo mode. The macOS/Linux command uses curl and bash; the Windows command uses PowerShell. Both download prebuilt binaries and start a single-node server with an ephemeral self-signed certificate and temporary store. ```bash curl -fsSL https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.sh | bash -s -- --demo ``` ```powershell $env:LORE_DEMO=1; irm https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.ps1 | iex ``` -------------------------------- ### Start Lore Server with default settings Source: https://epicgames.github.io/lore/how-to/deploy-local-lore-server Run the server in the foreground using default installation paths. ```bash ~/.local/bin/loreserver ``` ```powershell & "$env:USERPROFILE\bin\loreserver.exe" ``` -------------------------------- ### Start loreserver with default settings (Windows PowerShell) Source: https://epicgames.github.io/lore/how-to/deploy-local-lore-server?q= Runs the server in the foreground with default settings on Windows. Requires the install path used in the PowerShell install script. ```powershell & "$env:USERPROFILE\bin\loreserver.exe" ``` -------------------------------- ### Install prebuilt binary on Windows Source: https://epicgames.github.io/lore/how-to/install-lore-cli Run this command in PowerShell to download and install the Lore binary on Windows. ```powershell irm https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.ps1 | iex ``` -------------------------------- ### Start server with custom configuration Source: https://epicgames.github.io/lore/how-to/deploy-local-lore-server Launch the server pointing to the directory containing the local.toml file. ```bash ~/.local/bin/loreserver --config /opt/loreserver/config ``` ```powershell & "$env:USERPROFILE\bin\loreserver.exe" --config C:\loreserver\config ``` -------------------------------- ### Install binary to user bin on Windows Source: https://epicgames.github.io/lore/how-to/install-lore-cli Create a bin directory in your user profile and copy the compiled executable there. ```powershell New-Item -ItemType Directory -Force "$env:USERPROFILE\bin" Copy-Item target\release\lore.exe "$env:USERPROFILE\bin\lore.exe" ``` -------------------------------- ### Incorrect glossary definition example Source: https://epicgames.github.io/lore/developing/doc-standards/operational/glossary-conventions Incorrect definition style: starts with 'This term refers to' and uses second person. Avoid this pattern in glossary entries. ```markdown ### Commit (n) This term refers to the act of saving changes to the repository. ``` -------------------------------- ### Install Lore Server from binary (bash) Source: https://epicgames.github.io/lore/how-to/deploy-local-lore-server?q= Downloads and installs the server binary on macOS/Linux using the provided script. Sets the server flag. ```bash curl -fsSL https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.sh | bash -s -- --server ``` -------------------------------- ### Sense disambiguation example Source: https://epicgames.github.io/lore/developing/doc-standards/operational/glossary-conventions Shows the required format for separate entries when a term has two senses (verb vs noun). Each sense gets its own H3 headword with a part-of-speech tag in parentheses, on consecutive lines. ```markdown ### Commit (v) To record a snapshot of the staged changes as a new commit (`lore commit`). ### Commit (n) A snapshot of the working tree at a point in time. Each commit has a unique ID and a parent commit. ``` -------------------------------- ### Code-Standard page template Source: https://epicgames.github.io/lore/developing/doc-standards/canon/doc-types Template for a Code-Standard doc page. It includes the required H1 title, one-sentence lede, optional Overview section, numbered rule sections with imperative rules and rationale, and a fenced code example for each rule. Use this as a starting point when creating a new Code-Standard page. ```markdown # Lore standards ## Overview ## 1. ``` ``` ``` -------------------------------- ### Create repository (Windows) Source: https://epicgames.github.io/lore/tutorials/quickstart?q= Create and enter a project directory on Windows, then initialize the Lore repository. ```bash mkdir ~/my-project cd ~/my-project ``` ```bash lore repository create lore://127.0.0.1:41337/my-project ``` -------------------------------- ### Verify Lore installation Source: https://epicgames.github.io/lore/how-to/install-lore-cli Check the installed version of Lore to confirm the installation was successful. ```bash lore --version ``` -------------------------------- ### Install Vale with Homebrew Source: https://epicgames.github.io/lore/developing/doc-standards/tools Install Vale using Homebrew on macOS or Linux. After installation, verify the version with `vale --version`. ```bash brew install vale ``` ```bash vale --version ``` -------------------------------- ### Create server directory layout Source: https://epicgames.github.io/lore/how-to/deploy-local-lore-server Prepare the filesystem structure for persistent storage and certificates. ```bash mkdir -p /opt/loreserver/config /opt/loreserver/certs ``` ```powershell New-Item -ItemType Directory -Force C:\loreserver\config, C:\loreserver\certs ```