Add a jekyll based documentation

LICENSE.md

@@ -0,0 +1,39 @@
+---
+layout: default
+title: License
+parent: Licenses
+nav_order: 0
+---
+
+BSD 3-Clause License
+
+```
+Copyright 2019-2021 Kitware SAS
+Copyright 2021-2022 Michael Migliore, Mathieu Westphal
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```

README.md

@@ -0,0 +1,67 @@
+[![CI](https://github.com/f3d-app/f3d/actions/workflows/ci.yml/badge.svg)](https://github.com/f3d-app/f3d/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/f3d-app/f3d/branch/master/graph/badge.svg?token=siwG82IXK7)](https://codecov.io/gh/f3d-app/f3d) [![Downloads](https://img.shields.io/github/downloads/f3d-app/f3d/total.svg)](https://github.com/f3d-app/f3d/releases)
+
+# F3D - Fast and minimalist 3D viewer
+By Michael Migliore and Mathieu Westphal.
+
+<img src="https://user-images.githubusercontent.com/3129530/195972584-11ebb000-4939-47f4-9719-9d55e18867b0.png" align="left" width="20px"/>
+F3D (pronounced `/fɛd/`) is a fast and minimalist 3D viewer. It supports many file formats, from digital content to scientific datasets (including glTF, STL, STEP, PLY, OBJ, FBX, Alembic), can show animations and support lot of rendering and texturing options including real time physically based rendering and raytracing.
+<br clear="left"/>
+
+It is fully controllable from the command line and support configuration files. It can provide thumbnails, support interactive hotkeys, drag&drop and integration into file managers.
+
+F3D also contains the libf3d, a simple library to render meshes, with C++, Python and Java Bindings.
+
+<img src="https://user-images.githubusercontent.com/3129530/194735416-3f386437-456c-4145-9b5e-6bb6451d7e9a.png" width="640">
+
+*A typical render by F3D*
+
+<img src="https://user-images.githubusercontent.com/3129530/194735261-dd6f1c1c-fa57-47b0-9d27-f735d18ccd5e.gif" width="640">
+
+*Animation of a glTF file within F3D*
+
+<img src="https://user-images.githubusercontent.com/3129530/194735272-5bcd3e7c-a333-41f5-8066-9b0bec9885e8.png" width="640">
+
+*A direct scalars render by F3D*
+
+See the [gallery](doc/GALLERY.md) for more images, take a look at the [changelog](doc/CHANGELOG.md) or go to the [releases page](https://github.com/f3d-app/f3d/releases) to download F3D!
+
+# Quickstart
+
+Open a file and visualize it interactively:
+
+```
+f3d /path/to/file.ext
+```
+
+Open a file and save the rendering into an image file:
+
+```
+f3d /path/to/file.ext --output=/path/to/img.png
+```
+
+Get help:
+
+```
+f3d --help
+man f3d # Linux only
+```
+
+# Documentation
+
+- To get started, please take a look at the [user documentation](doc/README.md).
+- If you need any help, are looking for a feature or found a bug, please open an [issue](https://github.com/f3d-app/f3d/issues).
+- If you want to use the libf3d, please take a look at its [documentation](doc/libf3d/README.md).
+- If you want to build F3D and contribute to it, please take a look at the [developper documentation](doc/dev/README.md).
+
+# Support
+
+F3D is developed by a team of passionate devs. Please use F3D and star it on github to support us!
+
+# Acknowledgments
+
+F3D was initially created by [Kitware SAS](https://www.kitware.eu/) and is relying on many awesome open source projects, including [VTK](https://vtk.org/), [OCCT](https://dev.opencascade.org/), [Assimp](https://www.assimp.org/), [Alembic](http://www.alembic.io/) and [OSPRay](https://www.ospray.org/).
+
+# License
+
+F3D can be used and distributed under the 3-Clause BSD License, see the [license](LICENSE.md).
+F3D rely on other libraries and tools, all under permissive licenses, see the [third party licenses](doc/THIRD_PARTY_LICENSES.md).

_config.yml

@@ -0,0 +1,29 @@
+remote_theme: just-the-docs/just-the-docs
+plugins:
+  - jekyll-remote-theme
+  - jekyll-relative-links
+relative_links:
+  enabled: true
+  collections: true
+include:
+  - _readme.md
+  - _licenses.md
+exclude:
+  - testing/data/DATA_LICENSES.md
+title: F3D
+description: Fast and minimalist 3D viewer
+logo: /resources/logotype.svg
+color_scheme: dark
+
+# Aux links for the upper right navigation
+aux_links:
+  "<img src=\"https://user-images.githubusercontent.com/3129530/197903476-11d9c41d-73b0-461f-93e8-c8c00c680e6e.png\" width=\"30px\">":
+    - "//github.com/f3d-app/f3d"
+
+# Makes Aux links open in a new tab.
+aux_links_new_tab: true
+
+# External navigation links
+nav_external_links:
+  - title: Download F3D
+    url: https://github.com/f3d-app/f3d/releases

_includes/head_custom.html

@@ -0,0 +1 @@
+<link rel="shortcut icon" type="image/png" href="https://raw.githubusercontent.com/f3d-app/f3d/master/resources/logo32.png">

_licenses.md

@@ -0,0 +1,6 @@
+---
+layout: default
+title: Licenses
+nav_order: 5
+has_children: true
+---

_readme.md

@@ -0,0 +1,9 @@
+---
+layout: default
+title: Home
+nav_order: 0
+description: "F3D - Fast and minimalist 3D viewer"
+permalink: /
+---
+
+{% include_relative README.md %}

cmake/installing.cmake

@@ -46,7 +46,7 @@ if (UNIX AND NOT APPLE AND NOT ANDROID)
   set(F3D_DOC_DIR ${CMAKE_INSTALL_DOCDIR})
 endif()
 
-install(FILES LICENSE THIRD_PARTY_LICENSES.md README.md
+install(FILES LICENSE.md doc/THIRD_PARTY_LICENSES.md README.md
   DESTINATION ${F3D_DOC_DIR} COMPONENT documentation)
 
 list(APPEND config_files

cmake/packaging.cmake

@@ -7,7 +7,7 @@ set(CPACK_PACKAGE_VENDOR "${PROJECT_NAME}-app")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PROJECT_DESCRIPTION}")
 set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.md")
 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/README.md")
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE.md")
 set(CPACK_PACKAGE_EXECUTABLES f3d f3d)
 set(CPACK_CREATE_DESKTOP_LINKS f3d)
 
@@ -20,7 +20,7 @@ if(WIN32 AND NOT UNIX)
   # For some reason, we need Windows backslashes
   # https://www.howtobuildsoftware.com/index.php/how-do/PNb/cmake-nsis-bmp-cpack-how-to-set-an-icon-in-nsis-install-cmake
   # BMP3 format is also required (recommended size is 150x57)
-  set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/resources\\\\logo.bmp")
+  set(CPACK_PACKAGE_ICON "${CMAKE_SOURCE_DIR}/resources\\\\logotype64.bmp")
   set(CPACK_NSIS_MENU_LINKS ${f3d_url} "F3D Website")
   set(CPACK_NSIS_MODIFY_PATH ON)
   set(CPACK_NSIS_MUI_ICON ${f3d_ico})