Skip to content

Commit

Permalink
Update README.md (#2)
Browse files Browse the repository at this point in the history
Included Build Instructions section.
  • Loading branch information
TeaSmith7 authored Jan 10, 2024
1 parent 9b5a80b commit 462d151
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,20 @@ to retrieve values from specific fields of a given HL7 message natively, i.e., w
the raw pipe-delimited message into another object oriented format. Because its using scala under the hood,
this approach seems to be working very effectively and can return values very fast.

# Build Instructions
## Prerequisites
- Java Development Kit (JDK) 11
- Scala (Version) 2.13.10
- SBT (Scala Build Tool)
- GitHub Personal Access Token

## Installation
- Clone the repository: https://github.com/CDCgov/hl7-pet.git
- Create GITHUB_TOKEN from your personal GithHub Settings>Developer Settings->Personal Access Tokens>Generate New Token(with any scope), set it as environment variable and update the build.sbt file accordingly
- Build the project
- from sbt terminal run 'package' command for jar file to be generated


# Extracting Values from a HL7 message.

For a code example on how to initialize the parser, look intot he ExampleApp under test/scala.
Expand Down Expand Up @@ -111,4 +125,4 @@ Here's the list of available tools:<BR>
* CSVReader:<BR>
Simple class to read comma-delimited files (or any delimiter for that matter)
* ConsoleProgress:<BR>
Class that shows dots in the console as feedback for the user that the app still working.
Class that shows dots in the console as feedback for the user that the app still working.

0 comments on commit 462d151

Please sign in to comment.