From 125fa25e5e39a5fd415f3e65200a4beeedba2c39 Mon Sep 17 00:00:00 2001 From: SiriChandanaGarimella <156231102+SiriChandanaGarimella@users.noreply.github.com> Date: Thu, 14 Nov 2024 15:09:21 -0600 Subject: [PATCH] Updated README.md with steps to use the application --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 156c7a91..2e0e9ab4 100644 --- a/README.md +++ b/README.md @@ -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: + +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).