Skip to content

Commit 5739f4e

Browse files
Lorenzo ArboitLorenzo Arboit
authored andcommitted
Updated links
1 parent 2c5e7e7 commit 5739f4e

File tree

7 files changed

+135
-34
lines changed

7 files changed

+135
-34
lines changed

package-lock.json

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
"react-hook-form": "^7.53.0",
5555
"react-resizable-panels": "^2.1.3",
5656
"react-router-dom": "^6.26.2",
57+
"react-router-hash-link": "^2.4.3",
5758
"recharts": "^2.12.7",
5859
"sonner": "^1.5.0",
5960
"tailwind-merge": "^2.5.2",

src/components/Download.tsx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ const DownloadSection = () => {
1010
name: "Windows",
1111
icon: <Monitor className="h-8 w-8" />,
1212
description: "Tested on Windows 10 and later",
13-
downloadLink: "#",
13+
downloadLink: "https://seafile.unistra.fr/f/626347ee28b64ea5b4c7/?dl=1",
1414
version: "v1.0.0",
15-
size: "45 MB"
15+
size: "477 MB"
1616
},
1717
{
1818
name: "macOS",
@@ -25,10 +25,8 @@ const DownloadSection = () => {
2525
{
2626
name: "Linux",
2727
icon: <Smartphone className="h-8 w-8" />,
28-
description: "Compatible with Ubuntu 20.04+ and other distributions",
29-
downloadLink: "#",
30-
version: "v1.0.0",
31-
size: "48 MB"
28+
description: "Coming Soon",
29+
downloadLink: "https://youtu.be/dQw4w9WgXcQ?si=Vau63eVAjTnD4zl8",
3230
}
3331
];
3432

src/components/Footer.tsx

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { Github, ExternalLink } from "lucide-react";
22
import { Link } from "react-router-dom";
3+
import { HashLink } from "react-router-hash-link";
34

45
const Footer = () => {
56
return (
@@ -26,14 +27,14 @@ const Footer = () => {
2627
</p>
2728
<div className="flex space-x-4">
2829
<a
29-
href="#"
30+
href="https://github.com/CAMMA-public/Endoshare_code"
3031
className="text-muted-foreground hover:text-primary transition-colors"
3132
aria-label="GitHub Repository"
3233
>
3334
<Github className="h-5 w-5" />
3435
</a>
3536
<Link
36-
to="/docs"
37+
to="/docs#using-endoshare"
3738
className="text-muted-foreground hover:text-primary transition-colors"
3839
aria-label="Documentation"
3940
>
@@ -46,17 +47,25 @@ const Footer = () => {
4647
<div>
4748
<h4 className="font-semibold mb-4">Project</h4>
4849
<ul className="space-y-2 text-muted-foreground">
49-
<li><a href="#features" className="hover:text-primary transition-colors">Features</a></li>
50-
<li><a href="#download" className="hover:text-primary transition-colors">Download</a></li>
5150
<li>
52-
<Link to="/docs" className="hover:text-primary transition-colors">
51+
<HashLink smooth to="/#features" className="hover:text-primary transition-colors">
52+
Features
53+
</HashLink>
54+
</li>
55+
<li>
56+
<HashLink smooth to="/#download" className="hover:text-primary transition-colors">
57+
Download
58+
</HashLink>
59+
</li>
60+
<li>
61+
<Link to="/docs#using-endoshare" className="hover:text-primary transition-colors">
5362
Documentation
5463
</Link>
5564
</li>
5665
<li>
57-
<Link to={{ pathname: "/docs", hash: "#installation" }} className="hover:text-primary transition-colors">
58-
System Requirements
59-
</Link>
66+
<HashLink smooth to="/docs#installation" className="hover:text-primary transition-colors">
67+
Installation From Source
68+
</HashLink>
6069
</li>
6170
</ul>
6271
</div>
@@ -65,7 +74,11 @@ const Footer = () => {
6574
<div>
6675
<h4 className="font-semibold mb-4">Resources</h4>
6776
<ul className="space-y-2 text-muted-foreground">
68-
<li><a href="#about" className="hover:text-primary transition-colors">About</a></li>
77+
<li>
78+
<HashLink smooth to="/#about" className="hover:text-primary transition-colors">
79+
About
80+
</HashLink>
81+
</li>
6982
<li>
7083
<a
7184
href="http://camma.u-strasbg.fr/"

src/components/Header.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const Header = ({ minimal = false }: HeaderProps) => {
3333
Download
3434
</a>
3535
<a
36-
href="https://github.com/your-repo"
36+
href="https://github.com/CAMMA-public/Endoshare_code"
3737
className="text-muted-foreground hover:text-foreground transition-colors"
3838
target="_blank"
3939
rel="noopener noreferrer"
@@ -54,7 +54,7 @@ const Header = ({ minimal = false }: HeaderProps) => {
5454
<div className="flex items-center gap-3 justify-self-end">
5555
<Button variant="outline" size="sm" asChild>
5656
<a
57-
href="https://github.com/your-repo"
57+
href="https://github.com/CAMMA-public/Endoshare_code"
5858
target="_blank"
5959
rel="noopener noreferrer"
6060
className="flex items-center gap-2"

src/components/Hero.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ const Hero = () => {
4040
</Button>
4141

4242
<Button variant="outline" size="lg" className="w-full sm:w-auto" asChild>
43-
<a href="https://github.com/your-repo" target="_blank" rel="noopener noreferrer" className="flex items-center gap-2">
43+
<a href="https://github.com/CAMMA-public/Endoshare_code" target="_blank" rel="noopener noreferrer" className="flex items-center gap-2">
4444
<Github className="h-5 w-5" />
4545
View Source Code
4646
</a>

src/pages/Documentation.tsx

Lines changed: 92 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -230,30 +230,106 @@ const Documentation = () => {
230230
requirements below before cloning the repository.
231231
</p>
232232
</div>
233-
<div className="grid gap-6 md:grid-cols-[1fr_minmax(0,1.2fr)]">
233+
234+
{/* Three-column responsive grid */}
235+
<div className="grid gap-6 md:grid-cols-3">
236+
{/* MacOS Box */}
234237
<div className="rounded-xl bg-card border p-6 space-y-4">
235-
<h3 className="text-xl font-semibold">Requirements</h3>
238+
<h3 className="text-xl font-semibold">Requirements — macOS</h3>
236239
<ul className="list-disc pl-5 space-y-2 text-muted-foreground">
237-
<li>Python ≥ 3.11</li>
238-
<li>FFmpeg</li>
239-
<li>OpenCV</li>
240-
<li>TensorFlow</li>
241-
<li>PyQt5</li>
242-
<li>loguru</li>
243-
<li>tqdm</li>
244-
<li>psutil</li>
240+
<li>certifi==2025.10.5</li>
241+
<li>charset-normalizer==3.4.4</li>
242+
<li>colorlog==6.10.1</li>
243+
<li>contourpy==1.3.2</li>
244+
<li>cycler==0.12.1</li>
245+
<li>fonttools==4.60.1</li>
246+
<li>idna==3.11</li>
247+
<li>kiwisolver==1.4.9</li>
248+
<li>loguru==0.7.3</li>
249+
<li>matplotlib==3.10.7</li>
250+
<li>numpy==2.2.6</li>
251+
<li>opencv-python==4.12.0.88</li>
252+
<li>packaging==25.0</li>
253+
<li>Pillow==12.0.0</li>
254+
<li>psutil==7.1.1</li>
255+
<li>pyparsing==3.2.5</li>
256+
<li>PyQt5==5.15.11</li>
257+
<li>PyQt5-Qt5==5.15.17</li>
258+
<li>PyQt5_sip==12.17.1</li>
259+
<li>python-dateutil==2.9.0.post0</li>
260+
<li>requests==2.32.5</li>
261+
<li>six==1.17.0</li>
262+
<li>tqdm==4.67.1</li>
263+
<li>urllib3==2.5.0</li>
264+
<li>vidgear==0.3.3</li>
245265
</ul>
246266
</div>
267+
268+
{/* Windows Box */}
269+
<div className="rounded-xl bg-card border p-6 space-y-4">
270+
<h3 className="text-xl font-semibold">Requirements — Windows</h3>
271+
<p className="text-muted-foreground text-sm">Requires Python&nbsp;3.10 on Windows</p>
272+
<ul className="list-disc pl-5 space-y-2 text-muted-foreground">
273+
<li>tensorflow-cpu==2.10.1</li>
274+
<li>numpy&gt;=1.23,&lt;2.0</li>
275+
<li>opencv-python&lt;4.9</li>
276+
<li>PyQt5==5.15.11</li>
277+
<li>vidgear==0.3.3</li>
278+
<li>tqdm&gt;=4.66</li>
279+
<li>requests&gt;=2.31</li>
280+
<li>protobuf==3.19.6</li>
281+
<li>tensorboard&lt;2.11</li>
282+
<li>pillow&gt;=9.4</li>
283+
<li>loguru&gt;=0.7</li>
284+
<li>colorlog&gt;=6.8</li>
285+
<li>matplotlib==3.10.7</li>
286+
<li>psutil==7.1.1</li>
287+
</ul>
288+
</div>
289+
290+
{/* From Source Box */}
247291
<div className="rounded-xl bg-card border p-6 space-y-4">
248292
<h3 className="text-xl font-semibold">From Source</h3>
249293
<p className="text-muted-foreground">
250-
Use the following commands to clone, install dependencies, and launch the application.
294+
Follow these steps to clone the repository, install dependencies, download model weights, and
295+
set up FFmpeg before launching Endoshare.
251296
</p>
252297
<pre className="bg-muted rounded-lg p-4 text-sm overflow-x-auto">
253-
<code>{`git clone https://github.com/your-org/Endoshare.git
254-
cd Endoshare
255-
pip install -r requirements.txt
256-
python app.py`}</code>
298+
<code>{`# 1. Clone the repository
299+
git clone https://github.com/CAMMA-public/Endoshare_code.git
300+
cd Endoshare
301+
302+
# 2. Install Python dependencies
303+
pip install -r requirements.txt
304+
305+
# 3. Download model weights (OOBNet)
306+
# Create the checkpoint directory and download weights into it
307+
cd endoshare/resources
308+
mkdir -p ckpt
309+
cd ckpt
310+
wget https://s3.unistra.fr/camma_public/github/oobnet_detection/ckpt/oobnet_weights.h5
311+
cd ../../../
312+
313+
# 4. Install FFmpeg binaries
314+
# The FFmpeg executable must be placed inside: endoshare/Externals/ffmpeg/
315+
316+
# ── macOS / Linux ────────────────────────────────
317+
# Create the folder and download the static build
318+
mkdir -p endoshare/Externals/ffmpeg
319+
cd endoshare/Externals/ffmpeg
320+
wget https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz
321+
tar -xf ffmpeg-release-amd64-static.tar.xz
322+
mv ffmpeg-*-static/ffmpeg .
323+
cd ../../../..
324+
325+
# ── Windows ─────────────────────────────────────
326+
# 1. Go to https://www.gyan.dev/ffmpeg/builds/
327+
# 2. Download "ffmpeg-git-full.7z"
328+
# 3. Extract it and copy the ffmpeg.exe binary into:
329+
# endoshare\\Externals\\ffmpeg\\ffmpeg.exe
330+
331+
# 5. Launch Endoshare
332+
python main.py`}</code>
257333
</pre>
258334
</div>
259335
</div>
@@ -401,7 +477,7 @@ python app.py`}</code>
401477

402478
<section className="rounded-2xl border bg-muted/30 p-8 space-y-4 text-center">
403479
<h2 className="text-2xl font-semibold">Important Disclaimer</h2>
404-
<p className="text-muted-foreground max-w-3xl mx-auto">
480+
<p className="text-muted-foreground max-w-4xl mx-auto">
405481
Endoshare is research and educational software. It is not a medical device and is not certified for clinical or
406482
diagnostic use. Manual review of outputs is recommended to ensure privacy assurance before sharing any content.
407483
</p>

0 commit comments

Comments
 (0)