Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koemigg committed Jun 23, 2023
1 parent 4148879 commit 3b15ec1
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@ This directory contains examples of how to use the deltabae.sh script in the par
- `a.txt`, `b.txt`: Text files to be compared.
- `diff.html` (to be generated): This file will be generated after running the script. It contains the side-by-side diff of `a.txt` and `b.txt` with syntax highlighting.

<!-- TODO: Change to accept arguments -->

## Steps to Run the Example

1. Navigate to the parent directory: `cd ..`
2. Run the deltabae.sh script: `bash deltabae.sh`
3. Open the generated `diff.html` file in a web browser to view the output.
1. Move into this directory: `cd example`
2. Run the deltabae.sh script: `bash ../deltabae.sh -f a.txt -s b.txt`
3. Open the generated `./tmp/diff.html` file in a web browser to view the output.

The `diff.html` file should show the differences between `a.txt` and `b.txt` in a side-by-side format with syntax highlighting.

0 comments on commit 3b15ec1

Please sign in to comment.