Skip to content

Commit

Permalink
Merge pull request #109 from oss-slu/update-readme-file
Browse files Browse the repository at this point in the history
Updated README.md with steps to use the application
  • Loading branch information
SiriChandanaGarimella authored Nov 14, 2024
2 parents 4256106 + dba97e1 commit 22b126d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ To start the components individually, please follow the below instructions:
1. To start the client-app: [client-app README.md](client-app/README.md/)
2. To start the server: [server README.md](server/README.md)

## Steps to use the application for ORCA log files:

1. For input, you can select any ORCA log file. The test log files are in the esp/test-data/orca-files.
2. Once the input is provided, click on upload.
3. Provide the search term
4. Provide the lines specified as: WHOLE or FIRST N (where N = number of lines. Ex: FIRST 5 or FIRST 10) or LAST N (where N = number of lines. Ex: LAST 5 or LAST 10)
5. Provide the sections (cycle from which the data must be extracted) as 1 or 1,2 or 1,2,3
6. The ‘Use total lines’ and ‘Total number of lines for output doc’ are non-mandatory fields and can be left blank.
7. Click on the ‘Preview Output’ button to view the data extraction results
8. Click on the ‘Download Output’ button to download the data extraction results as a WORD document

## Contributing

To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
Expand Down

0 comments on commit 22b126d

Please sign in to comment.