Improved GitHub pages & fixed some typos in there

Signed-off-by: NGines Hidalgo <gineshidalgo99@gmail.com>

.github/CI_deprecated/Readme_Travis_badges_table_and_backup_instructions.md

 In order to recover Travis:
 1. Uncomment all the lines of code in ".travis.yml" and move it back to the main folder (e.g., at the same level than the global README.md and CMakeLists.txt files).
 2. Re-add the table of badges in the README.md:
+
 |                  |`Default Config`  |`CUDA (+Python)`  |`CPU (+Python)`   |`OpenCL (+Python)`| `Debug`          | `Unity`          |
 | :---:            | :---:            | :---:            | :---:            | :---:            | :---:            | :---:            |
 | **`Linux`**   | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/1)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/2)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/3)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/4)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/5)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) | [![Status](https://travis-matrix-badges.herokuapp.com/repos/CMU-Perceptual-Computing-Lab/openpose/branches/master/6)](https://travis-ci.org/CMU-Perceptual-Computing-Lab/openpose) |

.github/issue_template.md

@@ -82,4 +82,4 @@ Select the topic(s) on your post, delete the rest:
     - Portable demo or compiled library?
 
 10. If **speed performance** issue:
-    - Report OpenPose timing speed based on [this link](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/speed_up_openpose.md#profiling-speed).
+    - Report OpenPose timing speed based on [this link](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/maximizing_openpose_speed.md#profiling-speed).

.github/workflows/main.yml

@@ -51,8 +51,6 @@ jobs:
               WITH_CUDNN: false
               WITH_PYTHON: true
               CI_OS_NAME: linux
-              CI_BUILD_NUMBER: ${{ github.run_number }}
-              CI_COMMIT: ${{ github.sha }}
             DOCS: true
           # Ubuntu 20.04 - Python - CMake - CPU
           - os: ubuntu-20.04

.gitignore

@@ -32,7 +32,6 @@
 *.sst
 *.ldb
 LOCK
-LOG*
 CURRENT
 MANIFEST-*
 

README.md

@@ -10,14 +10,14 @@
 
 [**OpenPose**](https://github.com/CMU-Perceptual-Computing-Lab/openpose) has represented the **first real-time multi-person system to jointly detect human body, hand, facial, and foot keypoints (in total 135 keypoints) on single images**.
 
-It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](https://people.eecs.berkeley.edu/~zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](https://jhugestar.github.io), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser)**, and **maintained by [Gines Hidalgo](https://www.gineshidalgo.com) and [Yaadhav Raaj](https://www.raaj.tech)**. OpenPose would not be possible without the [**CMU Panoptic Studio dataset**](http://domedb.perception.cs.cmu.edu). We would also like to thank all the people who helped OpenPose in any way ([doc/contributors.md](doc/contributors.md)).
+It is **authored by [Ginés Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](https://people.eecs.berkeley.edu/~zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](https://jhugestar.github.io), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser)**, and **maintained by [Ginés Hidalgo](https://www.gineshidalgo.com) and [Yaadhav Raaj](https://www.raaj.tech)**. OpenPose would not be possible without the [**CMU Panoptic Studio dataset**](http://domedb.perception.cs.cmu.edu). We would also like to thank all the people who helped OpenPose in any way ([doc/authors_and_contributors.md](doc/authors_and_contributors.md)).
 
 
 
 <p align="center">
     <img src=".github/media/pose_face_hands.gif", width="480">
     <br>
-    <sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> (left) and <a href="https://jhugestar.github.io" target="_blank">Hanbyul Joo</a> (right) in front of the <a href="http://domedb.perception.cs.cmu.edu" target="_blank">CMU Panoptic Studio</a></sup>
+    <sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> (left) and <a href="https://jhugestar.github.io" target="_blank">Hanbyul Joo</a> (right) in front of the <a href="http://domedb.perception.cs.cmu.edu" target="_blank">CMU Panoptic Studio</a></sup>
 </p>
 
 
@@ -54,7 +54,7 @@ It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](htt
     <img src=".github/media/pose_face.gif", width="360">
     <img src=".github/media/pose_hands.gif", width="360">
     <br>
-    <sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> (left image) and <a href="http://www.cs.cmu.edu/~tsimon" target="_blank">Tomas Simon</a> (right image) testing OpenPose</sup>
+    <sup>Authors <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> (left image) and <a href="http://www.cs.cmu.edu/~tsimon" target="_blank">Tomas Simon</a> (right image) testing OpenPose</sup>
 </p>
 
 ### Unity Plugin
@@ -63,7 +63,7 @@ It is **authored by [Gines Hidalgo](https://www.gineshidalgo.com), [Zhe Cao](htt
     <img src=".github/media/unity_body_foot.png", width="240">
     <img src=".github/media/unity_hand_face.png", width="240">
     <br>
-    <sup><a href="http://tianyizhao.com" target="_blank">Tianyi Zhao</a> and <a href="https://www.gineshidalgo.com" target="_blank">Gines Hidalgo</a> testing the <a href="https://github.com/CMU-Perceptual-Computing-Lab/openpose_unity_plugin" target="_blank">OpenPose Unity Plugin</a></sup>
+    <sup><a href="http://tianyizhao.com" target="_blank">Tianyi Zhao</a> and <a href="https://www.gineshidalgo.com" target="_blank">Ginés Hidalgo</a> testing the <a href="https://github.com/CMU-Perceptual-Computing-Lab/openpose_unity_plugin" target="_blank">OpenPose Unity Plugin</a></sup>
 </p>
 
 ### Runtime Analysis
@@ -94,7 +94,7 @@ We show an inference time comparison between the 3 available pose estimation lib
     - [**Command-line demo**](doc/demo_quick_start.md) for built-in functionality.
     - [**C++ API**](examples/tutorial_api_cpp/) and [**Python API**](doc/python_api.md) for custom functionality. E.g., adding your custom inputs, pre-processing, post-posprocessing, and output steps.
 
-For further details, check [all released features](doc/released_features.md) and [release notes](doc/release_notes.md).
+For further details, check the [major released features](doc/major_released_features.md) and [release notes](doc/release_notes.md) docs.
 
 
 

doc/README.md

-OpenPose - Quick Start
+OpenPose Doc
 ==========================
 
 Most users can simply use the OpenPose Demo without reading any C++/Python code. Users that need to add additional functionality (new inputs, outputs, etc) should check the C++/Python APIs:
@@ -25,7 +25,7 @@ bin\OpenPoseDemo.exe --video examples\media\video.avi --face --hand --write_json
 	- You should be familiar with the [**OpenPose Demo**](demo_quick_start.md) and the main OpenPose flags before trying to read the C++ or Python API examples. Otherwise, it will be way harder to follow.
     - For quick prototyping: You can simply duplicate and rename any of the [existing example files](../examples/tutorial_api_python/) within that same folder.
 
-- [**Speeding up OpenPose and benchmark**](speed_up_openpose.md): Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements for OpenPose.
+- [**Speeding up OpenPose and benchmark**](maximizing_openpose_speed.md): Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements for OpenPose.
 
 - [**Calibration toolbox**](advanced/calibration_module.md) and [**3D OpenPose**](advanced/3d_reconstruction_module.md): Calibrate your cameras for 3D OpenPose (or any other stereo vision tasks) and start obtaining 3D keypoints!
 

doc/advanced/3d_reconstruction_module.md

-OpenPose 3-D Reconstruction Module and Demo
+OpenPose Doc - Advanced Doc - OpenPose 3-D Reconstruction Module and Demo
 =============================================
 
 ## Contents

doc/advanced/calibration_module.md

-OpenPose Calibration Module and Demo
+OpenPose Doc - Advanced Doc - OpenPose Calibration Module and Demo
 =============================================
 
 ## Contents

doc/advanced/deployment.md

-Deploying OpenPose (Exporting OpenPose to Other Projects)
+OpenPose Doc - Advanced Doc - Deploying OpenPose (Exporting OpenPose to Other Projects)
 ==========================
 
 ## Contents

doc/advanced/library_structure/README.md

-OpenPose C++ API - Introduction
+OpenPose Doc - Advanced Doc - Library Structure
 ====================================
 
 As a user, you do not need to know anything about this section! This section is intended for OpenPose internal developpers. It is exposed publicly, but you can skip this whole folder if you are just trying to use OpenPose or create new code/demos using OpenPose.

doc/advanced/library_structure/library_add_new_module.md

-OpenPose - Steps to Add a New Module
+OpenPose Doc - Advanced Doc - Library Structure - Steps to Add a New Module
 ====================================
 
 ## Developing Steps

doc/advanced/library_structure/library_extend_functionality.md

-OpenPose - How to Develop OpenPose
+OpenPose Doc - Advanced Doc - Library Structure - How to Extend Functionality
 ====================================
 
 If you intend to extend the functionality of our library:

doc/advanced/library_structure/library_how_to_develop.md

-OpenPose C++ API - How to Develop OpenPose
+OpenPose Doc - Advanced Doc - Library Structure - How to Develop OpenPose
 ======================================================
 
 

doc/advanced/library_structure/library_overview.md

-OpenPose C++ API - Basic Overview
+OpenPose Doc - Advanced Doc - Library Structure - Basic Overview
 ====================================
 
 

doc/advanced/standalone_face_or_hand_keypoint_detector.md

-OpenPose - Standalone Face Or Hand Keypoint Detector
+OpenPose Doc - Advanced Doc - Standalone Face Or Hand Keypoint Detector
 ====================================
 
 In case of hand camera views at which the hands are visible but not the rest of the body, or if you do not need the body keypoint detector and want to speed up the process, you can use the OpenPose face or hand keypoint detectors with your own face or hand detectors, rather than using the body keypoint detector as initial detector for those.

doc/contributors.md → doc/authors_and_contributors.md

-OpenPose - Authors and Contributors
+OpenPose Doc - Authors and Contributors
 ====================================
 
 
 
 ### Authors
-OpenPose is authored by [Gines Hidalgo](https://www.gineshidalgo.com/), [Zhe Cao](http://www.andrew.cmu.edu/user/zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon/), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](http://www.cs.cmu.edu/~hanbyulj/), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser/).
-
-The body pose estimation work is based on the following and original 2 repositories: [CVPR 2017 repository](https://github.com/ZheC/Multi-Person-Pose-Estimation) and [ECCV 2016 repository](https://github.com/CMU-Perceptual-Computing-Lab/caffe_rtpose).
+OpenPose is authored by [Ginés Hidalgo](https://www.gineshidalgo.com/), [Zhe Cao](http://www.andrew.cmu.edu/user/zhecao), [Tomas Simon](http://www.cs.cmu.edu/~tsimon/), [Shih-En Wei](https://scholar.google.com/citations?user=sFQD3k4AAAAJ&hl=en), [Hanbyul Joo](http://www.cs.cmu.edu/~hanbyulj/), and [Yaser Sheikh](http://www.cs.cmu.edu/~yaser/). The body pose estimation work is based on the following and original 2 repositories: [CVPR 2017 repository](https://github.com/ZheC/Multi-Person-Pose-Estimation) and [ECCV 2016 repository](https://github.com/CMU-Perceptual-Computing-Lab/caffe_rtpose).
 
 
 

doc/demo_not_quick_start.md

-OpenPose Demo - Not Quick Start
+OpenPose Doc - Demo - Not Quick Start
 ====================================
 
 This document is a more detailed continuation of [doc/demo_quick_start.md](demo_quick_start.md), and it assumes the user is quite familiar with the OpenPose demo and the contents of [doc/demo_quick_start.md](demo_quick_start.md).

doc/demo_quick_start.md

-OpenPose Demo - Quick Start
+OpenPose Doc - Demo - Quick Start
 ====================================
 
 Forget about the OpenPose code, just download the portable Windows binaries (or compile the code from source) and use the demo by following this tutorial!

doc/faq.md

-OpenPose - Frequently Asked Question (FAQ)
+OpenPose Doc - Frequently Asked Question (FAQ)
 ============================================
 
 ## Contents
@@ -207,26 +207,26 @@ git submodule update --init --recursive --remote
 #### Speed Up, Memory Reduction, and Benchmark
 **Q: Low speed** - OpenPose is quite slow, is it normal? How can I speed it up?
 
-**A**: Check [doc/speed_up_openpose.md](speed_up_openpose.md) to discover the approximate speed of your graphics card and some speed tips.
+**A**: Check [doc/maximizing_openpose_speed.md](maximizing_openpose_speed.md) to discover the approximate speed of your graphics card and some speed tips.
 
 
 
 #### How to Measure the Latency Time?
 **Q: How to measure/calculate/estimate the latency/lag time?**
 
-**A**: [Profile](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/speed_up_openpose.md#profiling-speed) the OpenPose speed. For 1-GPU or CPU-only systems (use `--disable_multi_thread` for simplicity in multi-GPU systems for latency measurement), the latency will be roughly the sum of all the reported measurements.
+**A**: [Profile](https://github.com/CMU-Perceptual-Computing-Lab/openpose/blob/master/doc/maximizing_openpose_speed.md#profiling-speed) the OpenPose speed. For 1-GPU or CPU-only systems (use `--disable_multi_thread` for simplicity in multi-GPU systems for latency measurement), the latency will be roughly the sum of all the reported measurements.
 
 
 
 #### CPU Version Too Slow
 **Q: The CPU version is insanely slow compared to the GPU version.**
 
-**A**: Check [doc/speed_up_openpose.md#cpu-version](speed_up_openpose.md#cpu-version) to discover the approximate speed and some speed tips.
+**A**: Check [doc/maximizing_openpose_speed.md#cpu-version](maximizing_openpose_speed.md#cpu-version) to discover the approximate speed and some speed tips.
 
 
 
 #### Profiling Speed and Estimating FPS without Display
-Check the [doc/speed_up_openpose.md#profiling-speed](speed_up_openpose.md#profiling-speed) section.
+Check the [doc/maximizing_openpose_speed.md#profiling-speed](maximizing_openpose_speed.md#profiling-speed) section.
 
 
 

doc/installation/README.md

-OpenPose - Installation
+OpenPose Doc - Installation
 ==========================
 
 ## Contents
@@ -132,7 +132,7 @@ cmake-gui ..
 
 5. Set the `GPU_MODE` flag to the proper value and click `Configure` again:
     1. If your machine has an Nvidia GPU, you should most probably not modify this flag and skip this step. Cases in which you might have to change it:
-        - If you have a Nvidia GPU with 2GB of memory or less: Then you will have to follow some of the tricks in [doc/speed_up_openpose.md](../speed_up_openpose.md) or change `GPU_MODE` back to `CPU_ONLY`.
+        - If you have a Nvidia GPU with 2GB of memory or less: Then you will have to follow some of the tricks in [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md) or change `GPU_MODE` back to `CPU_ONLY`.
         - If you cannot install CUDA, then you can also set `GPU_MODE` to `CPU_ONLY`.
     2. Mac OSX and machines with a non-Nvidia GPU (Intel or AMD GPUs): Set the `GPU_MODE` flag to `CPU_ONLY` (easier to install but slower runtime) or `OPENCL` (GPU-accelerated, it is harder to install but provides a faster runtime speed). For more details on OpenCV support, see [doc/prerequisites.md](prerequisites.md) and [OpenCL Version](#opencl-version).
     3. If your machine does not have any GPU, set the `GPU_MODE` flag to `CPU_ONLY`.
@@ -276,7 +276,7 @@ See [doc/advanced/deployment.md](../advanced/deployment.md).
 
 
 ### Maximum Speed
-Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements to run OpenPose on [doc/speed_up_openpose.md](../speed_up_openpose.md).
+Check the OpenPose Benchmark as well as some hints to speed up and/or reduce the memory requirements to run OpenPose on [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md).
 
 
 
@@ -297,7 +297,7 @@ export MKL_NUM_THREADS="8"
 export OMP_NUM_THREADS="8"
 ```
 
-Increasing the number of threads results in a higher RAM memory usage. You can check the [doc/speed_up_openpose.md](../speed_up_openpose.md) for more information about speed and memory requirements in several CPUs and GPUs.
+Increasing the number of threads results in a higher RAM memory usage. You can check the [doc/maximizing_openpose_speed.md](../maximizing_openpose_speed.md) for more information about speed and memory requirements in several CPUs and GPUs.
 
 
 

doc/installation/deprecated/installation_deprecated.md

-OpenPose - Installation (deprecated)
+OpenPose Doc - Installation (deprecated)
 ======================================
 
 ## Contents

doc/installation/jetson_tx/installation_jetson_tx1.md

-OpenPose - Installation on Nvidia Jetson TX1
+OpenPose Doc - Installation - Installation on Nvidia Jetson TX1
 ====================================
 ## Introduction
 We do not officially support TX1, but thanks to @dreinsdo, we have these instructions about how he made it work in his TX1. We would like to thank @dreinsdo, who added this documentation in [this GitHub issue post](https://github.com/CMU-Perceptual-Computing-Lab/openpose/issues/1124#issuecomment-474090671). If you face any issue, feel free to post on that issue post.

doc/installation/jetson_tx/installation_jetson_tx2_jetpack3.1.md

-OpenPose - Installation on Nvidia Jetson TX2
+OpenPose Doc - Installation - Installation on Nvidia Jetson TX2 JetPack 3.1
 ====================================
 Note that OpenPose for Nvidia Jetson TX2 was developed and it is maintained by the community. The OpenPose authors will not be able to provide official support for it.
 

doc/installation/jetson_tx/installation_jetson_tx2_jetpack3.3.md

-OpenPose - Installation on Nvidia Jetson TX2
+OpenPose Doc - Installation - Installation on Nvidia Jetson TX2 JetPack 3.3
 ====================================
 Note that OpenPose for Nvidia Jetson TX2 was developed and it is maintained by the community. The OpenPose authors will not be able to provide official support for it.
 

doc/installation/prerequisites.md

-OpenPose - Prerequisites
+OpenPose Doc - Installation - Prerequisites
 ==========================
 
 ## Contents

doc/released_features.md → doc/major_released_features.md

-OpenPose - All Major Released Features
+OpenPose Doc - Major Released Features
 ====================================
 
 - Nov 2020: [**Python API improved and included on Windows portable binaries**](https://github.com/CMU-Perceptual-Computing-Lab/openpose/releases)!

doc/speed_up_openpose.md → doc/maximizing_openpose_speed.md

-OpenPose - Maximizing the OpenPose Speed
+OpenPose Doc - Maximizing the OpenPose Speed
 ========================================================================================
 
 ## Contents
@@ -30,7 +30,7 @@ OpenPose displays the FPS in the basic GUI. However, more complex speed metrics
 - Time measurement for 1 graphic card: The FPS will be the slowest time displayed in your terminal command line (as OpenPose is multi-threaded). Times are in milliseconds, so `FPS = 1000/millisecond_measurement`.
 - Time measurement for >1 graphic cards: Assuming `n` graphic cards, you will have to wait up to `n` x `F` frames to visualize each graphic card speed (as the frames are splitted among them). In addition, the FPS would be: `FPS = minFPS(speed_per_GPU/n, worst_time_measurement_other_than_GPUs)`. For < 4 GPUs, this is usually `FPS = speed_per_GPU/n`.
 
-Make sure that `wPoseExtractor` time is the slowest timing. Otherwise the input producer (video/webcam codecs issues with OpenCV, images too big, etc.) or the GUI display (use OpenGL support as detailed in [doc/speed_up_openpose.md](speed_up_openpose.md)) might not be optimized.
+Make sure that `wPoseExtractor` time is the slowest timing. Otherwise the input producer (video/webcam codecs issues with OpenCV, images too big, etc.) or the GUI display (use OpenGL support as detailed in [Speed Up Preserving Accuracy](#speed-up-preserving-accuracy)) might not be optimized.
 
 
 

doc/output.md

-OpenPose - Output
+OpenPose Doc - Output
 ====================================
 
 

doc/output_advanced_heatmaps.md

-OpenPose - Heatmap Output (Advanced)
+OpenPose Doc - Output - Heatmaps (Advanced)
 ====================================
 
 

doc/python_api.md

-OpenPose - Python API
+OpenPose Doc - Python API
 ====================================
 
 ## Contents

doc/release_notes.md

-OpenPose - Release Notes
+OpenPose Doc - Release Notes
 ====================================
 
 
@@ -446,6 +446,7 @@ OpenPose - Release Notes
         3. More examples added to the demo quick start documentation.
     6. Calibration doc links to included chessboard pdf.
     7. Deprecated examples directories `tutorial_add_module` and `tutorial_api_thread` (and renamed as `deprecated`). They still compile, but we no longer support them.
+    8. GitHub Pages autogenerated into https://cmu-perceptual-computing-lab.github.io/openpose with README.md, doc/ and include/openpose folders.
 2. Functions or parameters renamed:
     1. Added GitHub Actions (Workspaces) to test Ubuntu and Mac OSX versions (rather than the deprecated Travis). Travis was giving many issues, that were not OpenPose errors, making Travis not usable. Its code has been left for now (but commented out).
 3. Main bugs fixed: