Reorganize repository for unified release - #39
Conversation
Remove NSI scripts and move towards dotnet tool deployment.
Brings the repository into compliance with the standardised build infrastructure.
|
It would be nice to also generate the register table for the API using Otherwise, the documentation portions of this PR look good to me! |
|
Hi @glopesdev! @banchan86 and I are working on having the first few docs sites ready by end of September and are looking forward to having them served on harp-tech.org. I wanted to check what is the timeline for this repo reorganization so we can coordinate. The Sound Card and Timestamp Generator repos are also part of that first doc upload. Thanks for letting us know. |
|
@ChucklesOnGitHub that sounds very much on target, with the release of the python interface we will be focusing on wrapping this next. |
Adopt the standardised repository layout described in harp-tech/protocol#145, aligning this repository with the conventions shared by other Harp components and enabling a unified release of firmware, software, and documentation from a single CI pipeline.
Repository layout and build infrastructure
Firmwarefolder becomesfirmware,Hardwarebecomeshardware, andInterfacebecomessoftware. A newdocs/folder is introduced as the root for repository documentation and assets.software/build/, includingCommon.csproj.props,Common.csproj.targets, andPackage.props, for consistent project metadata and packaging across software components.Self-contained documentation website
Add documentation scaffolding under
docs/, includingdocfx.json, template, articles, images, and workflows. The shared harp-tech/docfx-tools repository is included as thedocs/harp-docfxsubmodule. The site is built from the API metadata of the software components and published from the same CI pipeline that produces the firmware and software releases.Cross-platform App packaging
Replace the platform-specific NSIS installer with a cross-platform
dotnet toolpackage for the GUI App, installable on any platform with the .NET SDK and launchable asharp.behavior.Notes
After merging, contributors will need to run
git submodule update --init --recursiveanddotnet tool restorewhen checking out the repository.