Skip to content

Update README.md #3

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
AdamW78 merged 1 commit into from
Feb 14, 2025
Merged

Update README.md #3

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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,18 @@ The data entry automator is a tool that allows you to automate the process of en

## Usage

The program can currently only be run from the command line, though a GUI is planned for the future.
The program can currently be run from either the command line or via a GUI.

### Running the Program
##### Not Recommended
Run the program using the following command:
```bash
java -jar data-entry-automator.jar -i <input file> [options]
```

##### Recommended
Run the program by installing the app using one of releases on the (releases)[https://github.com/AdamW78/Data-Entry-Automator/releases] page. Once installed, navigate to the install location (or create a desktop shortcut) and open the application to access the GUI. The program should look something like:

#### Options

| Argument | Short Form | Usage | Description | Default Value |
Expand Down Expand Up @@ -48,4 +53,4 @@ The input to the data entry automator is a `.xlsx` file with the following colum
>
> In the above example, only the `Condition`, `Sample Number`, `Baseline`, and `Day XX` columns are used.
>
> The `Strain` column is excluded in the example, but the `Condition` column is present, so it is okay. The file would be fine with a `Condition` and `Strain` column or just a `Strain` column, but it would not be valid with neither.
> The `Strain` column is excluded in the example, but the `Condition` column is present, so it is okay. The file would be fine with a `Condition` and `Strain` column or just a `Strain` column, but it would not be valid with neither.