Skip to content

Commit c24935a

Browse files
authored
Update README with executable download instructions
Removed tests badge and added download instructions for executables.
1 parent 6217271 commit c24935a

1 file changed

Lines changed: 12 additions & 22 deletions

File tree

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
![Python](https://img.shields.io/badge/Python-3.12-blue)
44
![Streamlit](https://img.shields.io/badge/Streamlit-local_app-red)
5-
![Tests](https://github.com/utkarsh0493/FSS-Navigator-App/actions/workflows/tests.yml/badge.svg)
65
![License](https://img.shields.io/badge/License-MIT-green)
76

87
A local Streamlit application for navigating standardized computational project structures.
@@ -36,21 +35,6 @@ It showcases:
3635
- Privacy-first local execution
3736
- No upload of project files
3837

39-
## Screenshots
40-
41-
> Screenshots will be added as the interface matures.
42-
43-
### Project overview
44-
45-
![Project overview](CodeDocumentations/images/project_overview.png)
46-
47-
### File index
48-
49-
![File index](CodeDocumentations/images/file_index.png)
50-
51-
### Reproducibility report
52-
53-
![Reproducibility report](CodeDocumentations/images/reproducibility_report.png)
5438

5539
## Project structure
5640

@@ -69,11 +53,17 @@ FSS-Navigator-App/
6953
└── README.md
7054
```
7155

72-
## Run the app
7356

74-
From the folder you want to inspect:
57+
## Download executable
58+
59+
Pre-built executables are available from the GitHub Releases page.
60+
61+
Download the version for your operating system:
62+
63+
- macOS
64+
65+
- Windows
66+
67+
- Linux
7568

76-
```bash
77-
cd /path/to/computational_project
78-
python /path/to/FSS-Navigator-App/run_app.py
79-
```
69+
After unzipping, run the executable from the folder you want to inspect.

0 commit comments

Comments
 (0)