Skip to content

Comments

Added README and pr build#2

Merged
rbnswartz merged 1 commit intodevelopfrom
rs/ci-and-readme
Jan 29, 2026
Merged

Added README and pr build#2
rbnswartz merged 1 commit intodevelopfrom
rs/ci-and-readme

Conversation

@rbnswartz
Copy link
Member

@rbnswartz rbnswartz commented Jan 29, 2026

This pull request introduces a GitHub Actions workflow for building the project on pull requests and significantly expands the project documentation. The new CI workflow ensures that the project is automatically built and dependencies are restored for every PR targeting the develop branch. The updated README.md provides comprehensive instructions for building, running, configuring, and understanding the application, making it much easier for new contributors and users to get started.

Continuous Integration:

  • Added a new GitHub Actions workflow (.github/workflows/pr-build.yml) that checks out the code (including submodules), sets up the .NET 10.0 environment, restores dependencies, and builds the project on every pull request to the develop branch.

Documentation Improvements:

  • Expanded the README.md to include a detailed project description, prerequisites, build and run instructions (including Docker usage), configuration details (with examples for environment variables, appsettings.json, and command-line arguments), an overview of application components, and a clear outline of the processing flow and supported file types.

@rbnswartz rbnswartz merged commit 3d09d8d into develop Jan 29, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants