Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sillsdev/solid

Solid is a software tool that can be used to check, clean up, and convert Standard Format (e.g. Toolbox) lexicon data.
https://github.com/sillsdev/solid

Last synced: 3 months ago
JSON representation

Solid is a software tool that can be used to check, clean up, and convert Standard Format (e.g. Toolbox) lexicon data.

Awesome Lists containing this project

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](https://software.sil.org/solid/).

For bug reports, please [submit an issue in our issue tracker](https://github.com/sillsdev/solid/issues).

# 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
1. Once finished, visit https://github.com/sillsdev/solid/releases and modify the draft release, automatically created, to your satisfaction. Publish the release.
1. Publish the new installer file on software.sil.org

### Building locally (debug)

1. `dotnet restore src/solid.sln`
1. `dotnet build src/solid.sln` (debug)
or
1. `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/net461/*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](https://jrsoftware.org/isinfo.php) and `iscc.exe` is available in your PATH

`iscc .\installer\setup.iss`