Skip to content

Commit

Permalink
Improve wording and move text up
Browse files Browse the repository at this point in the history
  • Loading branch information
Yowgf committed Nov 29, 2023
1 parent 93dc8e7 commit d41ef69
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<span><img src="docs/images/LushuLogo.png" alt="Lushu Logo" width="100" height="100">
<span><img src="docs/images/lushu-logo.png" alt="Lushu Logo" width="100" height="100">
</div>

# Lushu
Expand Down Expand Up @@ -27,6 +27,11 @@ string, counting occurrences, sending an alert email, etc.

## Running

### Video Tutorial

Check out this [3-minute Lushu Tutorial](https://youtu.be/s17i2BhI_Eo) on
YouTube.

### Simulate Lushu

Run `gradle fatJar` to generate the file `./Lushu/build/libs/Lushu.jar`. Run it
Expand Down Expand Up @@ -110,12 +115,6 @@ Here are some more examples of words you can input:
Also, try specifying different YAML configuration files. You may find it easier
to edit the example file in `./example/config.yaml`.

### Video Tutorial

This page describes the basic steps to run Lushu. For a more detailed description of the process,
take a look into this
[Lushu Tutorial](https://youtu.be/s17i2BhI_Eo)

## Testing

To test, run `gradle test`. Find all source code for the tests under
Expand Down
File renamed without changes
Binary file added docs/images/youtube-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d41ef69

Please sign in to comment.