Update readme, separated website source

IGNF · Sep 3, 2024 · 9aecbb3 · 9aecbb3
1 parent de04778
commit 9aecbb3
Show file tree

Hide file tree

Showing 14 changed files with 135 additions and 101 deletions.
diff --git a/.github/workflows/deploy_doc.yml b/.github/workflows/deploy_doc.yml
@@ -34,10 +34,10 @@ jobs:
         cd doc_uni
         ./build_doc.sh
 
-    - name: Readme to html
+    - name: website.md to html
       run: |
         mkdir -p website
-        pandoc -s --metadata title="Comp3D" -f gfm README.md -o website/index.html -c data/comp3d_website.css && cp -R data/ *.md website
+        pandoc -s --metadata title="Comp3D" -f gfm data/website.md -H data/website_header.html -o website/index.html -c data/comp3d_website.css && cp -R data/ website
         cp -R doc_uni/en/html website/doc
         
     - name: Setup Pages

diff --git a/LISEZMOI.md b/LISEZMOI.md
diff --git a/README.md b/README.md
@@ -8,10 +8,12 @@ Copyright 1992-2024 [IGN France](https://www.ign.fr/), licensed under **GPLv3**
 
 Documentation
 -------------
-User documentation is accessible here:
-[IGNF.github.io/Comp3D/doc](https://IGNF.github.io/Comp3D/doc)
+Website:
+[ignf.github.io/Comp3D](https://ignf.github.io/Comp3D)
 
-or via *Comp3D>Help* menu.
+User documentation:
+[IGNF.github.io/Comp3D/doc](https://IGNF.github.io/Comp3D/doc)
+or offline from *Comp3D>Help* menu.
 
 
 Source files
@@ -22,6 +24,8 @@ Source files
 Installation
 -------------
 
+Get the latest compiled version: [github.com/IGNF/Comp3D/releases](https://github.com/IGNF/Comp3D/releases)
+
 ### Windows
 
 Extract the archive and run *Comp3D.exe*.
@@ -48,7 +52,12 @@ Deb installation creates a `comp3d5` link targeting the last Comp3D installation
 Getting started
 ---------------
 In Comp3D open an example .comp file.
-Read the `Getting Started` chapter of the user documentation.
+Read the [Getting Started](https://ignf.github.io/Comp3D/doc/gettingstarted.html) releases chapter of the user documentation.
+
+
+Compilation
+-----------
+[https://ignf.github.io/Comp3D/doc/compilation.html](https://ignf.github.io/Comp3D/doc/compilation.html)
 
 
 Contributors

diff --git a/data/gui.png b/data/gui.png
diff --git a/data/icon.png b/data/icon.png
diff --git a/data/logo.png b/data/logo.png
diff --git a/data/map.png b/data/map.png
diff --git a/data/report.png b/data/report.png
diff --git a/data/website.md b/data/website.md
@@ -0,0 +1,109 @@
+![logo_IGN](data/logo_comp3d5.png)
+
+**Comp3D** is an open-source micro-geodesy compensation software that enables computation on a limited spread network (few kilometers) using a global 3D least-squares bundle adjustment on several topometric observation types.
+The computation is done in a local 3D system based on an oblique stereographic projection with a spherical Earth model.
+
+Copyright 1992-2024 [IGN France](https://www.ign.fr/), licensed under **GPLv3** license, see [LICENSE.md](https://github.com/IGNF/Comp3D/blob/main/LICENSE.md).
+
+
+Documentation
+-------------
+User documentation is accessible here:
+[IGNF.github.io/Comp3D/doc](https://IGNF.github.io/Comp3D/doc)
+
+or via *Comp3D>Help* menu.
+
+
+Official repository
+-------------------
+
+[github.com/IGNF/Comp3D](https://github.com/IGNF/Comp3D)
+
+Installation
+-------------
+
+Get the latest compiled version: [github.com/IGNF/Comp3D/releases](https://github.com/IGNF/Comp3D/releases)
+
+
+Features
+--------
+
+- simple graphical user interface
+- html interactive report
+- simple input text format
+- input/output in any projection
+- topometric observations
+- subframes adjustment
+- rotation axes determination
+- vertical deflection
+- equality constraints
+- GNSS baselines
+- error detection assistance
+- many statistical indicators
+- internal constraints
+- simulations
+- [Sinex format](https://www.iers.org/IERS/EN/Organization/AnalysisCoordinator/SinexFormat/sinex.html) export
+- coordinates constraints covariance matrix input
+- relative precision export
+- pipeline integration, command line interface
+
+Screenshots
+-----------
+
+![gui](data/gui.png)
+
+![gui](data/report.png)
+
+![gui](data/map.png)
+
+
+Getting started
+---------------
+In Comp3D open an example .comp file.
+Read the [Getting Started](https://ignf.github.io/Comp3D/doc/gettingstarted.html) releases chapter of the user documentation.
+
+
+Compilation
+-----------
+[https://ignf.github.io/Comp3D/doc/compilation.html](https://ignf.github.io/Comp3D/doc/compilation.html)
+
+
+Contributors
+------------
+Refer to [CONTRIBUTORS.md](https://github.com/IGNF/Comp3D/blob/main/CONTRIBUTORS.md)
+
+
+Contributing
+------------
+Refer to [CONTRIBUTING.md](https://github.com/IGNF/Comp3D/blob/main/CONTRIBUTING.md)
+
+
+License
+-------
+Comp3D is provided with absolutely no warranty, under **GPLv3** license, see [LICENSE.md](https://github.com/IGNF/Comp3D/blob/main/LICENSE.md).
+
+Refer to [NOTICE.md](https://github.com/IGNF/Comp3D/blob/main/NOTICE.md) for the embedded and linked libraries.
+
+
+How to Cite
+-----------
+Please cite Comp3D and IGN if you use this software in your research or project.
+Proper citations help others find and reference this work and support its continued development.
+
+To cite this software, please use the following reference:
+
+```bibtex
+@software{IGNComp3D,
+  author = {IGN},
+  title = {Comp3D},
+  version = {5},
+  year = {2024},
+  url = {https://github.com/IGNF/Comp3D}
+}
+```
+
+Contacts
+--------
+[https://github.com/IGNF/Comp3D](https://github.com/IGNF/Comp3D) -- [comp3d@ign.fr](comp3d@ign.fr)
+
+![logo_IGN](data/logo_IGN.jpg)
diff --git a/data/website_header.html b/data/website_header.html
@@ -0,0 +1,3 @@
+<link rel="icon" type="image/x-icon" href="data/icon.png">
+<meta name="description" content="Comp3D is an open-source micro-geodesy compensation software by IGN France">
+<meta name="keywords"    content="Comp3D,Comp,metrology,geodesy,topometry">
diff --git a/distrib/make_appimagedeb.sh b/distrib/make_appimagedeb.sh
@@ -78,7 +78,7 @@ cd -
   cp -R $base/datasets/georef $dir_name/datasets/georef
   cp -R $base/datasets/gettingstarted $dir_name/datasets/gettingstarted
   cp -R $base/datasets/gettingfurther $dir_name/datasets/gettingfurther
-  cp $base/LICENSE.md $base/README.md $base/LISEZMOI.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
+  cp $base/LICENSE.md $base/README.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
   cp $base/src/*/LICENSE* $base/gui/html/LICENSE* $base/NOTICE.md $dir_name/licenses
   cp $base/data/logo_* $dir_name/data
   tar zcvf $base/${dir_name}.tgz $dir_name

diff --git a/distrib/make_ziplinux.sh b/distrib/make_ziplinux.sh
@@ -43,7 +43,7 @@ cd -
   cp -R $base/datasets/georef $dir_name/datasets/georef
   cp -R $base/datasets/gettingstarted $dir_name/datasets/gettingstarted
   cp -R $base/datasets/gettingfurther $dir_name/datasets/gettingfurther
-  cp $base/LICENSE.md $base/README.md $base/LISEZMOI.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
+  cp $base/LICENSE.md $base/README.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
   cp $base/src/*/LICENSE* $base/gui/html/LICENSE* $base/NOTICE.md $dir_name/licenses
   cp $base/data/logo_* $dir_name/data
   tar zcvf $base/${dir_name}.tgz $dir_name

diff --git a/distrib/make_zipwin.sh b/distrib/make_zipwin.sh
@@ -40,7 +40,7 @@ cd $1
   cp -R $base/datasets/georef $dir_name/datasets/georef
   cp -R $base/datasets/gettingstarted $dir_name/datasets/gettingstarted
   cp -R $base/datasets/gettingfurther $dir_name/datasets/gettingfurther
-  cp $base/LICENSE.md $base/README.md $base/LISEZMOI.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
+  cp $base/LICENSE.md $base/README.md $base/CONTRIBUTORS.md $base/changelog.txt $dir_name
   cp $base/src/*/LICENSE* $base/gui/html/LICENSE* $base/NOTICE.md $dir_name/licenses
   cp $base/data/logo_* $dir_name/data
   cp $base/data/comp3d5.xpm $dir_name

diff --git a/doc_uni/overview.rst b/doc_uni/overview.rst
@@ -12,6 +12,10 @@ The computation is done in a local 3D system based on an oblique stereographic p
 Features
 ================
 
+- simple graphical user interface (see :ref:`gui`)
+
+- html interactive report (see :ref:`out-report`)
+
 - simple input text format (see :ref:`input-files`)
 
 - input/output in any projection (see :ref:`georef-proj`)
@@ -42,7 +46,7 @@ Features
 
 - relative precision export (see :ref:`relative-precision`)
 
-- possibility of integrating an automatic pipeline (see :ref:`automatization`)
+- pipeline integration, command line interface (see :ref:`automatization`)
 
 - and more