update doc page welcome page

pmodwrc · Aug 8, 2024 · e705125 · e705125
1 parent 6bb29c0
commit e705125
Show file tree

Hide file tree

Showing 14 changed files with 174 additions and 276 deletions.
diff --git a/docs/contribution/contribution.md b/docs/contribution/contribution.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,20 +1,43 @@
-This site contains the project documentation for the
-**HAlpha** project that is a project realised from civil service employees at the PMOD/WRC in Davos, Switzerland.
+![Image title](layout/images/fits_logo.png#only-light)
+![Image title](layout/images/fits_logo_dark.png#only-dark)
 
-## Table Of Contents
+[![CI - Test](https://img.shields.io/github/actions/workflow/status/pmodwrc/fits2db/unit_test.yml?branch=main)](https://github.com/pmodwrc/fits2db/blob/main/.github/workflows/unit_test.yml) [![codecov](https://codecov.io/github/pmodwrc/fits2db/graph/badge.svg?token=92UPKXEOIH)](https://codecov.io/github/pmodwrc/fits2db) [![linting: pylint](https://img.shields.io/badge/linting-pylint-yellowgreen)](https://github.com/pylint-dev/pylint)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/fits2db.svg)](https://pypi.org/project/fits2db/) [![PyPI Downloads](https://img.shields.io/pypi/dm/fits2db.svg?label=PyPI%20downloads)](https://pypi.org/project/fits2db/) 
 
-The documentation is split up in 5 different parts. Use this to locate your deswired part of the project and start looking at the different pages.
 
-1. [Overview](overview.md)
-2. [Installation Guide](installation-guide/overview.md)
-3. [How-To Guides](how-to-guides/how-to-guide-livestream.md)
-4. [Reference](reference/cameracontrol.md)
-5. [Hardware](hardware.md)
+<div class="grid cards" markdown>
 
+-   :material-clock-fast:{ .lg .middle } __Set up in 1 minute__
 
-## Acknowledgements
+    ---
 
-I want to thank my house plants for providing me with
-a negligible amount of oxygen each day. Also, I want
-to thank the sun for providing more than half of their
-nourishment free of charge.
+    Install [`fits2db`](#) with [`pip`](/user-guide/installation) and get up
+    and running in minutes
+
+    [:octicons-arrow-right-24: Getting started](/user-guide/overview)
+
+-   :material-account-hard-hat-outline:{ .lg .middle } __Contribute__
+
+    ---
+
+    Are you missing something or found a bug?
+
+    [:octicons-arrow-right-24: Contribute](/contribution/contribution)
+
+-   :material-abacus:{ .lg .middle } __Focus on your data__
+
+    ---
+
+    You're tired of managing hundrets of fits files on your computer? Read about why this project is for you!
+
+    [:octicons-arrow-right-24: About this project](/user-guide/about-us)
+
+-   :material-scale-balance:{ .lg .middle } __Open Source, Apache License 2.0__
+
+    ---
+
+    fits2db is licensed under Apache License 2.0 and available on [GitHub](https://github.com/pmodwrc/fits2db/blob/main/LICENSE)
+
+    [:octicons-arrow-right-24: LICENSE](https://github.com/pmodwrc/fits2db/blob/main/LICENSE)
+
+</div>
diff --git a/docs/installation-guide/install-scratch.md b/docs/installation-guide/install-scratch.md
diff --git a/docs/installation-guide/overview.md b/docs/installation-guide/overview.md
diff --git a/docs/layout/images/fits_logo_dark.png b/docs/layout/images/fits_logo_dark.png
diff --git a/docs/user-guide/about-us.md b/docs/user-guide/about-us.md
@@ -0,0 +1,2 @@
+# About fits2db
+Why is this project existing and if it is for you or not.
diff --git a/docs/user-guide/examples.md b/docs/user-guide/examples.md
@@ -0,0 +1 @@
+# fits2db examples
diff --git a/docs/user-guide/how-to-guide-livestream.md b/docs/user-guide/how-to-guide-livestream.md
diff --git a/docs/user-guide/how-to-guide-set-focus.md b/docs/user-guide/how-to-guide-set-focus.md
diff --git a/docs/installation-guide/installation.md → docs/user-guide/installation.md b/docs/installation-guide/installation.md → docs/user-guide/installation.md
@@ -1,3 +1,36 @@
+
+# fits2db installation guide
+It is recommended to use a virtual environment when running this tool. Utilizing [`venv`](https://docs.python.org/3/library/venv.html) or [`conda`](https://www.anaconda.com/) ensures a clean and isolated environment, which is a best practice.
+
+## Install from [`PYPI`](https://pypi.org/project/fits2db/)
+
+
+!!! tip "You can just use pip to install this library "
+    ```bash 
+    pip install fits2db
+    ```
+    or for specific version use 
+    ```bash 
+    pip install fits2db==<your_version> 
+    ```
+
+
+## Install from source
+Clone this repo to your local machine. Once cloned navigate to the `root` directory of this project and run in your python environment 
+!!! tip "Build install with pip install"
+    ```bash 
+    pip install .
+    ```
+With this the `fits2db` lib should be installed. You can test if its properly installed by running the version command to check if you got the right version
+```bash title="ssh terminal"
+fits2db --version
+>>> fits2db, version 0.0.1
+```
+
+**Happy coding :sparkles:**
+
+
+
 # Copying a Pre-configured Image to an SD Card
 For those who prefer a quick setup or are less familiar with Linux and Raspberry Pi configurations, using a pre-configured image is the recommended approach.
 Requirements:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# About fits2db
		Why is this project existing and if it is for you or not.