search

sillsdev / solid

Solid is a software tool that can be used to check, clean up, and convert Standard Format (e.g. Toolbox) lexicon data.
MIT License
1 stars 2 forks source link

readme

SOLID

Solid is a Windows .Net Framework desktop application that can be used to check, clean up, and convert Standard Format (e.g. Toolbox) lexicon data. It is most commonly used by technology support personnel when bringing linguistic data from SIL Toolbox into SIL Fieldworks.

Learn more at software.sil.org.

For bug reports, please submit an issue in our issue tracker.

Developers

Pull request process

Generally, a PR is required for code changes. At least one approving review and all unit tests passing are required for a PR to be merged.

Releasing a new version

This project uses GitHub Actions CI to automate building, running unit tests, creating/signing an installer, and creating a GitHub release.

  1. Push a version tag in semantic version format (e.g vX.X.X) to the commit you want to release. This will kick off GHA to build, test, and create the installer
  2. Once finished, visit https://github.com/sillsdev/solid/releases and modify the draft release, automatically created, to your satisfaction. Publish the release.
  3. Publish the new installer file on software.sil.org

Building locally (debug)

  1. dotnet restore src/solid.sln
  2. dotnet build src/solid.sln (debug) or
  3. dotnet build -c Release src/solid.sln (release)

Alternatively you can use Visual Studio and build / run tests there

Running unit tests

dotnet test output/net481/*Tests.dll

Create an installer locally

GHA will do this for you, however if you need to test creating the installer locally:

Prerequisites: you have InnoSetup installed locally and iscc.exe is available in your PATH

iscc .\installer\setup.iss