Skip to content

Docs: Add setup and run steps for all projects #63

@SakshiTamshetti

Description

@SakshiTamshetti

I was exploring this repository as a new user and found it a bit hard to understand the exact steps to build and run each project.

Currently, the root README and project READMEs describe the high-level purpose, but they do not provide a clear, step-by-step “Getting Started” section for:

  • Kepware.Api
  • KepwareSync.Service
  • Kepware.Api.Sample

I would like to propose adding:

  • Required .NET SDK version(s) and build prerequisites.
  • Commands such as dotnet restore, dotnet build, and which project to dotnet run.
  • Where to configure the Kepware Configuration API base URL and credentials (environment variables or config files).
  • A minimal end-to-end example (for example, “run sample that lists channels/devices”).

If this sounds good, I would be happy to open a PR to add “Getting Started” sections to the root README and the individual project READMEs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions