Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nenotriple authored Nov 15, 2023
1 parent 85cd705 commit 59f227d
Showing 1 changed file with 40 additions and 20 deletions.
60 changes: 40 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ Display an image and text file side-by-side for easy manual caption editing.
# 📝 Usage

- Prepare Your Files:
- Put each image and its matching text file in the same folder. They must have the same name.
- Put each image and its matching text file in the same folder.
- If you choose to include a text pair for an image, ensure they are located in the same folder and have identical names.
- For example: `01.png` and `01.txt`, `02.jpg` and `02.txt`...
- Supported image types: `.png` `.jpg` `.jpeg` `.webp` `.bmp`


# 💡 Tips and Features

- Hotkeys:
Expand All @@ -21,24 +23,29 @@ Display an image and text file side-by-side for easy manual caption editing.
- `TAB`: Insert the highlighted suggestion.
- `CTRL+S`: Save the current text file.
- `CTRL+Z` / `CTRL+Y`: Undo/Redo.
- `CRTL+F`: Highlight all duplicate words.

- Tips:
- Highlight duplicates by selecting text.
- Right-click the directory button to copy the path.
- Middle-click the directory button to open the folder.
- Right-click or Middle-click the displayed image to open its folder.
- Get autocomplete suggestions while you type using Danbooru tags.
- `Highlight duplicates` by selecting text.
- `Autocomplete Suggestions` while you type using Danbooru tags.
- Enable `List View` to display text in a vertical list format.
- Enable `Big Comma Mode` for more visual separation between captions.
- Middle-click a token to quickly delete it.
- Right-click the directory button to copy the path.
- Right-click the image/text for a context menu.
- Blank text files can be created for images without any matching files when loading a directory.

- Text Tools:
- Search and Replace: Edit all text files at once.
- Prefix Text Files: Insert text at the START of all text files.
- Append Text Files: Insert text at the END of all text files.
- `Batch Token Delete`: View all tokens in a directory as a list, and quickly delete them.
- `Cleanup Text`: Fix simple typos in all text files of the selected folder.
- `Prefix Text Files`: Insert text at the START of all text files.
- `Append Text Files`: Insert text at the END of all text files.
- `Search and Replace`: Edit all text files at once.

- Auto-Save
- Check the auto-save box to save text when navigating between img/txt pairs or closing the window.
- Text is cleaned up when saved, so you can ignore things like trailing commas/spaces, double commas/spaces, etc.
- Text is cleaned when saved, so you can ignore typos such as duplicate tokens, multiple spaces or commas, missing spaces, and more.
- `Clean text on save` Can be disabled from the options menu. *(Disabling this may have adverse effects when inserting a suggestion)*

# 🚩 Requirements

Expand All @@ -56,17 +63,30 @@ The `danbooru.csv` file will be downloaded *(if not already available)* upon lau

# 📜 Version History

[v1.76 changes:](https://github.com/Nenotriple/img-txt_viewer/releases/tag/v1.76)
[v1.77 changes:](https://github.com/Nenotriple/img-txt_viewer/releases/tag/v1.77)
- New:
- Duplicate tokens are now removed when saving, cleaning, or inserting text.
- Periods at the end of words are now replaced with commas when saving or cleaning text.
- You can now enable or disable `Clean Text on Save`.
- Pillow is now installed much more gracefully than before. _(Python version only)_
- Various small UI tweaks

- `List View`: Display text files in a list format. Text is always saved in the standard single-line CSV format.
- `Always on Top`: Enable this to keep the window in focus.
- `Highlight All Duplicates`: Highlight all matching words in the text box.
- `Delete entire tokens`: By middle-clicking them.
- `Text Context menu`
- `Image Context menu`
- Enable or disable highlighting duplicate words when selecting text. _(Default = On)_
- You can now swap the image and text/control positions.
- Various UI tweaks, the biggest change being: Image scaling is now more flexible.

<br>

- Fixed:
- `Autocomplete Inserting` fixes:
- Duplicate trailing comma, duplicate first letter, no space inserted, double space inserted.
- Using undo after inserting a suggestion should no longer be as jarring.
- When highlighting words: Any _selected_ words longer than 3 characters would be _highlighted_. Now, only exact matches are highlighted.
- Window size no longer changes when changing maximum image size.
- You can no longer insert a suggestion "inside" an existing token.
- Code refactoring for improved cleanliness and maintainability.

**Batch Delete, v1.02 Changes:**

- New:
- You can now select multiple tokens then delete them all at once.

- Fixed:
- Newlines should be properly handled/deleted now.

0 comments on commit 59f227d

Please sign in to comment.