Skip to content

Commit 1695a86

Browse files
code2k13code2k13
committed
updated documentation
1 parent 1ef81cd commit 1695a86

File tree

2 files changed

+31
-27
lines changed

2 files changed

+31
-27
lines changed

‎docs/index.html‎

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<head>
55
<meta charset="utf-8">
66
<meta name="viewport" content="width=device-width, initial-scale=1">
7-
<title>Bootstrap demo</title>
7+
<title>Starrem2k13: Open source star removal tool</title>
88
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet"
99
integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
1010
<link href="https://cdn.jsdelivr.net/npm/[email protected]/fonts/remixicon.css" rel="stylesheet">
11+
<link rel="icon" type="image/x-icon" href="starrem.ico">
1112

1213
<style>
1314
code {
@@ -50,34 +51,33 @@
5051
<div class="p-1 mb-1 bg-light rounded-3">
5152
<div class="container-fluid py-1 text-center">
5253

53-
<p class="col-md-12 fs-4">
54-
<img src="starrem_term.jpeg" style="width:100%;max-width:720px" /><br />
54+
<p class="col-md-12 fs-4">
55+
56+
<img src="star2k13_video.gif" style="width:100%;max-width: 360px;" /> <br/>
5557

5658
Starrem2k13, a simple, easy tool and open source for removing stars from deep sky images.
5759
<br />
58-
<button class="btn btn-outline-secondary btn-sm" type="button">Try Online Demo <i
59-
class="ri-window-line"></i></button>
60-
<button class="btn btn-outline-secondary btn-sm" type="button">Run with Docker </button>
60+
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://ashishware.com/static/star_removal/index.html">Try Online Demo <i
61+
class="ri-window-line"></i></a>
62+
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://github.com/code2k13/starrem2k13#running-using-docker-recommended">Run with Docker </a>
6163

62-
<button class="btn btn-outline-secondary btn-sm" type="button">Download for Windows <i
63-
class="ri-windows-line"></i></button>
64-
<button class="btn btn-outline-secondary btn-sm" type="button"> Download for Ubuntu 20/Linux <i
65-
class="ri-ubuntu-line"></i></button>
66-
<button class="btn btn-outline-secondary btn-sm" type="button"> Download for MacOS <i
67-
class="ri-apple-line"></i></button>
64+
<a class="btn btn-outline-secondary btn-sm" type="button" href="">Download for Windows <i
65+
class="ri-windows-line"></i></a>
66+
<a class="btn btn-outline-secondary btn-sm" type="button" href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz"> Download for Ubuntu 20/Linux <i
67+
class="ri-ubuntu-line"></i></a>
68+
<a class="btn btn-outline-secondary btn-sm" href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz" type="button"> Download for MacOS <i
69+
class="ri-apple-line"></i></a>
6870

6971

7072
</p>
7173
</div>
7274

7375

7476
</div>
75-
<div class="container-fluid py-1 text-center">
76-
<img src="star2k13_video.gif" style="width:100%;max-width: 360px;" />
77-
</div>
77+
7878

7979

80-
<h3 id="gettingstarted">Getting Started</h3>
80+
<h2 id="gettingstarted">Getting Started</h3>
8181
<div>
8282

8383
<div class="accordion" id="accordionExample">
@@ -91,7 +91,7 @@ <h2 class="accordion-header" id="headingOne">
9191
<div id="collapseOne" class="accordion-collapse collapse show" aria-labelledby="headingOne"
9292
data-bs-parent="#accordionExample">
9393
<div class="accordion-body">
94-
Simply unzip the downloaded zip archive and run the below command in command prompt:
94+
Download the pre-built binaries for Windows <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.1_win/starrem2k13_win.zip">here</a>. Simply unzip the downloaded zip archive and run the below command in command prompt:
9595
<br />
9696
<code lang="javascript">
9797
starrem2k13 image_with_stars.jpg starless.jpg
@@ -110,7 +110,7 @@ <h2 class="accordion-header" id="headingTwo">
110110
<div id="collapseTwo" class="accordion-collapse collapse" aria-labelledby="headingTwo"
111111
data-bs-parent="#accordionExample">
112112
<div class="accordion-body">
113-
Execute the following commands:
113+
Download the pre-built binaries for Linux <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_linux/starrem2k13_ubuntu_20.04.tar.gz">here</a>.They have been tested with Ubuntu 20.04 and should work with other Linux distros. Execute the following commands:
114114
<br />
115115
<code>
116116
tar -xvzf starrem2k13_ubuntu_20.04.tar.gz <br/>
@@ -131,9 +131,8 @@ <h2 class="accordion-header" id="headingThree">
131131
<div id="collapseThree" class="accordion-collapse collapse" aria-labelledby="headingThree"
132132
data-bs-parent="#accordionExample">
133133
<div class="accordion-body">
134-
Unzip all the contents of the downloaded archive to a folder. Open Terminal, navigate to the
135-
folder and
136-
type the following command: <br />
134+
Download the pre-built binary for MacOS <a href="https://github.com/code2k13/starrem2k13/releases/download/v2.0_macos/starrem2k13_macos_12.tar.gz">here</a>. The executable should work with most versions of MacOS. Unzip all the contents of the downloaded archive to a folder. Open Terminal, navigate to the
135+
folder and type the following command: <br />
137136
<code>
138137
starrem2k13 image_with_stars.jpg starless.jpg
139138
</code>
@@ -176,17 +175,22 @@ <h2 class="accordion-header" id="headingFour">
176175
</div>
177176
</div>
178177

179-
<h3 id="faq">FAQ</h3>
180-
178+
<h2 id="faq" class="mt-4">FAQ</h2>
181179

182-
<h4>Where can I find source code for this tool?</h4>
180+
<p>
181+
<span class="fw-bold">Where can I find source code for this tool?</span><br/>
182+
The source code is available here : <a href="https://github.com/code2k13/starrem2k13">https://github.com/code2k13/starrem2k13</a> </p>
183183

184-
<h4>Can I train my own model and use with this tool?</h4>
184+
<p></p><span class="fw-bold">Can I train my own model and use with this tool?</span><br/>
185+
Yes you can, please refer to this section : <a href="https://github.com/code2k13/starrem2k13#training-model-on-your-images">https://github.com/code2k13/starrem2k13#training-model-on-your-images</a></p>
185186

186187

187-
<h4>I need help?</h4>
188+
<p><span class="fw-bold">I need help? </span><br/>
189+
You can reach out to me on Twitter <a href="https://twitter.com/patilsaheb">@patilsaheb</a></p>
188190

189-
<h4>I think I found a bug or issue with the code ?</h4>
191+
<p><span class="fw-bold">Why is the startup of the program so slow ?</span><br/>
192+
I use <a href="https://pyinstaller.org/en/stable/">PyInstaller</a> to create executables from my Python scripts. This tool basically creates a bundle with python, required dependencies, my scripts and
193+
model weights. When it runs, it needs to unpackage everything , which takes time.</p>
190194

191195

192196

‎docs/starrem.ico‎

43.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)