Skip to content

Commit 5f451df

Browse files
committed
Add GUI explanation to readme
1 parent eb15e64 commit 5f451df

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,33 @@ pip install iDeepLC
2222

2323
## Usage
2424

25+
### Graphical user interface (GUI)
26+
27+
If you prefer not to install Python or any dependencies, you can use the **standalone iDeepLC GUI** for Windows.
28+
This is a single `.exe` file that runs without any installation.
29+
30+
### How it works
31+
- When you run the `.exe`, a **terminal window** will first appear.
32+
This terminal acts as the **logger** for the GUI, showing progress and messages as the program runs.
33+
- Any **results** and **generated figures** will be saved **in the same folder** where the `.exe` file is located.
34+
35+
### Running the executable
36+
1. Download the `.exe` file from the [latest release](https://github.com/CompOmics/iDeepLC/releases).
37+
2. Double-click the file to run it.
38+
3. If Windows shows a security message:
39+
- **"Windows protected your PC"** — this is a standard warning for applications not signed with a commercial certificate.
40+
- Click **More info** and then **Run anyway** to start iDeepLC.
41+
> *This warning appears because the executable is built by the developers without a paid code-signing certificate.
42+
> The file is safe if downloaded from the official GitHub release page.*
43+
44+
45+
<img src="gui_screenshot.png" alt="iDeepLC gui" width="600">
46+
47+
48+
49+
50+
### CLI
51+
2552
The iDeepLC package provides a CLI for easy usage. Below are some examples:
2653
#### Prediction
2754
```sh

gui_screenshot.png

94.4 KB
Loading

0 commit comments

Comments
 (0)