updated documentation

Author: code2k13

README.md

@@ -1,20 +1,22 @@
 # Star reduction in deep sky images
 
-Starrem2k13 is a simple and easy tool to remove stars from astronomical images. Starrem2k13 uses a GAN trained on augmented data. Code was inspired from a [sample at Tensorflow's website](https://www.tensorflow.org/tutorials/generative/pix2pix). The training data consists of only two images. One image of the Helix nebula and another is a starmap that was created from a star cluster image. Here is how the results look like:
+Starrem2k13 is a simple tool for removing stars from astronomical images. Starrem2k13 uses a GAN trained on augmented data. It's code was inspired from a [sample at Tensorflow's website](https://www.tensorflow.org/tutorials/generative/pix2pix). The training data consists of only three base images.
+
+Below are examples of what it can do:
 
 ![images/example2.png](images/example2.jpg)
 
 ![images/example.png](images/example.jpg)
 
 
 # Installing
-Currently binaries for Windows, Linux and MacOS are available in the releases section. These were created using PyInstaller. Using pre-complied binaries is the recommended way of running Starrem2k13. Once you have downloaded and installed the program you can run it simply by typing the following in command prompt/terminal
+Currently binaries for Windows, Linux and MacOS are available in the releases section. These were created using PyInstaller. Using pre-complied binary is the recommended way of running Starrem2k13. Once you have downloaded and installed the program you can run it simply by typing the following in command prompt/terminal
 
 ```shell
 starrem2k13 image_with_stars.jpg  image_without_stars.jpg
 ```
 
-## Running using Docker (Recommended)
+## Running using Docker (if binaries don't work)
 
 ```
 docker run   -v $PWD:/usr/src/app/starrem2k13/data  \
@@ -24,7 +26,7 @@ docker run   -v $PWD:/usr/src/app/starrem2k13/data  \
 Note that *$PWD* refers to your current working directory. In the above example it is assumed that the file *example.jpg* resides in your current working directory. This directory is mounted as a volume with the path */usr/src/app/starrem2k13/data* inside the docker container. The output image *example_starless.jpg* will also be written to same directory.
 
 
-## Running with local python installation
+## Running with local python installation (for geeks)
 Clone the repository and navigate to the 'starrem2k13' folder. Install required packages :
 
 ```shell

docs/index.html

@@ -61,7 +61,7 @@
 
                     <img src="star2k13_video.gif" style="width:100%;max-width: 360px;" /> <br />
 
-                    Starrem2k13, a simple, easy tool and open source for removing stars from deep sky images.
+                    Starrem2k13, a simple open source for removing stars from deep sky images.
                     <br />
                     <a class="btn   btn-outline-secondary btn-sm" type="button"
                         href="https://ashishware.com/static/star_removal/index.html">Try Online Demo <i
@@ -200,13 +200,12 @@ <h2 id="faq" class="mt-4">FAQ</h2>
 
             <p>
                 <span class="fw-bold">Where can I find source code for this tool?</span><br />
-                The source code is available here : <a
-                    href="https://github.com/code2k13/starrem2k13">https://github.com/code2k13/starrem2k13</a>
+                The source code is available <a href="https://github.com/code2k13/starrem2k13">here</a>
             </p>
 
             <p></p><span class="fw-bold">Can I train my own model and use with this tool?</span><br />
-            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>
+            Yes you can, please refer to <a
+                href="https://github.com/code2k13/starrem2k13#training-model-on-your-images">this section.</a>
             </p>
 
 
@@ -219,6 +218,12 @@ <h2 id="faq" class="mt-4">FAQ</h2>
                 model weights. When it runs, it needs to unpackage everything , which takes time.</p>
 
 
+            <p><span class="fw-bold">How can I perform batch star removal?</span><br />
+                Checkout the <a href="https://github.com/code2k13/starrem2k13/blob/main/batch_process.sh">simple shell
+                    script</a> from the project's repo. Since Starrem2k13 is a command-line utility,
+                it can be used in many different ways.</p>
+
+
 
 
     </div>