Skip to content

Commit

Permalink
Some modification on README.md
Browse files Browse the repository at this point in the history
More easy to read
  • Loading branch information
KennardWang authored Jun 29, 2020
1 parent d1a637b commit e04bdd3
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,39 @@

------
### Development Environment
+ System : **Windows 10 64bits**
+ Language : **Java**
+ JDK : **8u202**
+ IDE : **Eclipse 2018-12 (4.10.0)**
------
### Download
+ [Release](https://github.com/KennardWang/UGMS_GUI/releases)
------
### Usage
### Usage ( ***for Windows*** )
+ Installation

> This project doesn't need external plugins. You can import my java code into java IDE to run, or launch the .jar document directly.
1. Install JDK ( ***8u202 has been released*** )
2. This project doesn't need other external plugins. You can import my java code into java IDE to run, or launch the `UGMS.GUI._2.1.jar` directly.
+ Sort

> 1. Click the "File" and choose "Open File" option.
> 2. Choose a .txt course file and select the sort approach.
> 3. Click the "Display" button.
> PS: GPA sort needs to import required files first !
> 1. Click the `File` and choose `Open File` option.
> 2. Choose a `.txt` course file and select the sort approach.
> 3. Click the `Display` button.
> **P.S. GPA sort needs to import required files first !**
+ Query

> 1. Click the "File" and choose "Import File" option.
> 2. Import all the .txt course files which you need by this way and then select the query approach.
> 3. Remember to input the corresponding query message.
Example:
ID: 1X09853X-X011-XXXX
Surname: Weng
WildCard(surname): W, We, We, Weng ... ( First letter must be upper case )
GPA Ranging: > 3.0, = 3.0, < 3.0, >= 3,0, <= 3.0 ( Need white space between the operator and the number )
> 4. Click the "Query" button.
> 1. Click the `File` and choose `Import File` option.
> 2. Import all the `.txt` course files which you need by this way and then select the query approach.
> 3. Remember to input the corresponding query message. ( ***Example*** )
> + ID : `1X09853X-X011-XXXX`
> + Surname : `Weng`
> + WildCard(surname) : `W, We, We, Weng ...` ( ***First letter must be upper case*** )
> + GPA Ranging: `> 3.0`, `= 3.0`, `< 3.0`, `>= 3,0`, `<= 3.0` ( ***Need white space between the operator and the number*** )
> 4. Click the `Query` button.
------
### Software Details
+ [Design Report](https://github.com/KennardWang/UGMS_GUI/blob/master/Design%20Report.pdf)
------
### License
+ [MIT License](https://github.com/KennardWang/UGMS_GUI/blob/master/LICENSE)
Expand Down

0 comments on commit e04bdd3

Please sign in to comment.