Instructions for PPA (#47)

* add glim ppa * trigger on push to master
koide3 · Jul 26, 2024 · 59251e1 · 59251e1
1 parent 3d65b3b
commit 59251e1
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 47 deletions.
diff --git a/.github/workflows/gendoc.yml b/.github/workflows/gendoc.yml
@@ -2,8 +2,7 @@ name: gendoc
 
 on:
   push:
-    tags:
-      - '*'
+    branches: [ master ]
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,12 +1,12 @@
 
-GLIM is tested on Ubuntu 22.04 / 24.04 with CUDA 12.2, and NVIDIA Jetson Orin (JetPack 6.0).
+GLIM is tested on Ubuntu 22.04 / 24.04 with CUDA 12.2 / 12.5, and NVIDIA Jetson Orin (JetPack 6.0).
+
+You can build and install GLIM from source code, or install pre-built binaries from PPA.
 
 ## Install from source
 
 ### Common dependencies
 
-#### From source
-
 ```bash
 # Install dependencies
 sudo apt install libomp-dev libboost-all-dev libmetis-dev \
@@ -46,48 +46,6 @@ sudo make install
 sudo ldconfig
 ```
 
-#### From [PPA](https://koide3.github.io/ppa/) [Ubuntu 24.04 , 22.04, 20.04 / AMD64, ARM64]
-
-##### Prequiresite
-
-```bash
-sudo apt install curl gpg
-```
-
-##### Setup PPA for Ubuntu 24.04
-
-```bash
-curl -s --compressed "https://koide3.github.io/ppa/ubuntu2404/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
-echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2404 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
-```
-
-##### Setup PPA for Ubuntu 22.04
-
-```bash
-curl -s --compressed "https://koide3.github.io/ppa/ubuntu2204/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
-echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2204 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
-```
-
-##### Setup PPA for Ubuntu 20.04
-
-```bash
-curl -s --compressed "https://koide3.github.io/ppa/ubuntu2004/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
-echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2004 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
-```
-
-##### Install dependencies
-
-```bash
-sudo apt update
-sudo apt install -y libiridescence-dev libboost-all-dev libglfw3-dev libmetis-dev
-
-# Choose one of the follows
-sudo apt install -y libgtsam-points-dev            # without CUDA
-sudo apt install -y libgtsam-points-cuda-12.2-dev  # with CUDA 12.2
-sudo apt install -y libgtsam-points-cuda-12.5-dev  # with CUDA 12.5
-```
-
-
 ### Install GLIM for ROS1
 
 ```bash
@@ -123,3 +81,56 @@ colcon build
 
 !!! note
     While AVX intrinsics can be enabled to speed up the mapping process by setting ```BUILD_WITH_MARCH_NATIVE=ON```, it sometimes causes segfaults unless ```march=native``` is properly set for *every* involved library. We recommend keeping it disabled if you are not sure.
+
+
+
+## Install from [PPA](https://koide3.github.io/ppa/) [Ubuntu 24.04 , 22.04, 20.04 / AMD64, ARM64]
+
+### Prequiresite
+
+```bash
+sudo apt install curl gpg
+```
+
+### Setup PPA
+
+```bash
+# Choose one of the follows
+
+# Automatically select ubuntu version via online script
+curl -s https://koide3.github.io/ppa/setup_ppa.sh | sudo bash
+
+# Manually setup PPA for Ubuntu 24.04
+curl -s --compressed "https://koide3.github.io/ppa/ubuntu2404/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
+echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2404 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
+
+# Manually setup PPA for Ubuntu 22.04
+curl -s --compressed "https://koide3.github.io/ppa/ubuntu2204/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
+echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2204 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
+
+# Manually setup PPA for Ubuntu 20.04
+curl -s --compressed "https://koide3.github.io/ppa/ubuntu2004/KEY.gpg" | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/koide3_ppa.gpg >/dev/null
+echo "deb [signed-by=/etc/apt/trusted.gpg.d/koide3_ppa.gpg] https://koide3.github.io/ppa/ubuntu2004 ./" | sudo tee /etc/apt/sources.list.d/koide3_ppa.list
+```
+
+### Install dependencies
+
+```bash
+sudo apt update
+sudo apt install -y libiridescence-dev libboost-all-dev libglfw3-dev libmetis-dev
+
+# Choose one of the follows
+sudo apt install -y libgtsam-points-dev            # without CUDA
+sudo apt install -y libgtsam-points-cuda-12.2-dev  # with CUDA 12.2
+sudo apt install -y libgtsam-points-cuda-12.5-dev  # with CUDA 12.5
+```
+
+### Install GLIM for ROS2
+
+```bash
+# Choose one of the follows
+sudo apt install -y ros-humble-glim-ros            # Without CUDA
+sudo apt install -y ros-humble-glim-ros-cuda12.2   # With CUDA 12.2
+sudo apt install -y ros-humble-glim-ros-cuda12.5   # With CUDA 12.5
+```
+