Skip to content
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.

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

Updated README.md with steps to use the application #109

Merged
merged 2 commits into from
Nov 14, 2024
Merged
Changes from all commits
Commits
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
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
Loading