Skip to content

(docs) Add build instructions to README #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dkayiwa merged 1 commit into from
Nov 14, 2025
Merged

(docs) Add build instructions to README #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ second based on `startedAt`. To leverage this option, one should ensure that th
their Priority Concept Set are ordered from least to highest priority.

#### Custom Sort Weight Generators
Modules that require this module can define and configure own custom algorithms. This would involve:
Modules that require this module can define and configure their own custom algorithms. This would involve:
* Create a Spring Component in your module that implements the `SortWeightGenerator` interface
* Provide a specific bean name for this Component that can be referenced
* Configure the `queue.sortWeightGenerator` global property with this bean name
Expand All @@ -111,3 +111,19 @@ Modules that require this module can define and configure own custom algorithms.
## Documentation

- REST documentation [here](https://rest.openmrs.org/#queue)

## Development

### Building

To build the module, run:

```bash
mvn clean install
```

To skip tests during build:

```bash
mvn clean install -DskipTests
```