Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
edited typos, image paths, and wordings.
  • Loading branch information
sonikkk-526 authored Oct 14, 2023
1 parent ae18221 commit b382dc0
Showing 1 changed file with 9 additions and 15 deletions.
24 changes: 9 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Lyrics Editor for .LRC
<p align="center">
<img alt="Editor-Icon" src="https://github.com/sonikkk-526/Lyrics-Editor-for-.LRC/blob/main/jar%20build%20and%20clean/editor_icon.png"><br><br>
<img alt="Editor-Icon" src="https://github.com/sonikkk-526/Lyrics-Editor-for-.LRC/blob/main/assets/editor_icon.ico"><br><br>

<a href="https://github.com/sonikkk-526">
<img alt="Author" src="https://img.shields.io/badge/Author-FlashSonic526-brightgreen?style=for-the-badge">
Expand All @@ -21,9 +21,9 @@

## ■ About this program
This is an open-sourced project that allows the user to easily modify and manage their .LRC (lyrics) files~!
- Users need to download runtime on their computer before using the .JAR application. (At least for the current version)
- [Latest version can be found here](https://github.com/FlashSonic526/Lyrics-Editor-for-.LRC/releases/latest)
![Lyrics Editor Screenshot](editor_showcase.png)
- Users need to download runtime on their computer before using the .JAR application (for the current version until notice)
- [Latest version](https://github.com/FlashSonic526/Lyrics-Editor-for-.LRC/releases/latest) can be found here
![Lyrics Editor Screenshot](assets/editor_showcase.png)
_*For more information and .JAR installation, please refer to the [latest release note](https://github.com/FlashSonic526/Lyrics-Editor-for-.LRC/releases).*_

Users should have a corresponding music player so that their lyrics files can be displayed (such as foobar2000, FiiO Music App, or others).
Expand All @@ -42,25 +42,19 @@ Users should have a corresponding music player so that their lyrics files can be


## ■ Download Instructions
### For the users of this program, you can:
1. Goto ["jar build and clean"](jar%20build%20and%20clean/) and download the whole folder (you could discard the .png and .ico)
**For the users of this program, you can:**
1. Goto ["dist"](src%20project/LyricsEditor-For_.lrc/dist) and download the whole folder (you may discard the .png and .ico)
2. Or, download the zipped file from the [latest release](https://github.com/FlashSonic526/Lyrics-Editor-for-.LRC/releases/latest)

_Note: downloading the .JAR requires java runtime, you can [download it here](https://java.com/en/download/manual.jsp) or [here](https://www.oracle.com/java/technologies/downloads/)._

**Also, the `lib` folder and its contents cannot be deleted!!** Otherwise the program would not work and you would have to re-download it here.


### For those working with the codes, you can:
1. Goto [source project/LyricsEditor-For_.lrc](source%20project/LyricsEditor-For_.lrc/); the library used in this project is in the [`lib`](source%20project/LyricsEditor-For_.lrc/lib)
2. Then, for the source codes, goto [src/com/lrc](source%20project/LyricsEditor-For_.lrc/src/com/lrc)

## ■ Uninstall Instructions
This program is a portable application which means that it is a standalone executable file, simply delete the entire folder would uninstall the program.
This program is a portable application (standalone executable file); simply deleting the entire folder would uninstall the program.

_*Since it is a portable application, it may not show up in "Programs and Features".*_
_*Since it is a portable application, it will not show up in "Programs and Features".*_

## ■ License & Copyright
Copyright (c) sonikkk-526 (known as sonik.- and FlashSonic526).

Licensed under the [BSD-4 Clause License](LICENSE).
Licensed under the [BSD-4 Clause License](LICENSE).

0 comments on commit b382dc0

Please sign in to comment.