Skip to content

Docs: add a run-in-console debugging walkthrough #4

@peopleworks

Description

@peopleworks

What

Expand the docs with a short run-in-console for debugging walkthrough: how to launch the service as a plain console app, watch live logs, and stop cleanly — versus installing it as a Windows Service.

Why

New contributors and evaluators want to try it fast without installing a service. A clear console path lowers the barrier.

Suggested approach

  • Add a subsection to CONTRIBUTING.md (and/or the README Quick start).
  • Cover: build, run as console, where logs go, how to trigger a job, and Ctrl+C shutdown.

Acceptance criteria

  • Step-by-step console run documented
  • Notes the difference vs. running as a Windows Service
  • Copy-paste commands that work on a clean checkout

Documentation good-first-issue — comment to claim it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions