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.
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.ApiKepwareSync.ServiceKepware.Api.SampleI would like to propose adding:
dotnet restore,dotnet build, and which project todotnet run.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.