Update documentation on the state of the project, etc...

- Create mdbook for the project, add documentation generation to the CI

- Change repo name to `flatpak-ext`

- Update author email to -.dev variant

Author: ryanabx

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: '0.4.10'
+          # mdbook-version: 'latest'
+
+      - run: mdbook build docs
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book

Cargo.toml

@@ -2,10 +2,10 @@
 name = "flatpak-ext"
 version = "0.2.0"
 edition = "2021"
-authors = ["Ryan Brue <[email protected]>"]
+authors = ["Ryan Brue <ryanbrue.dev@gmail.com>"]
 readme = "README.md"
-homepage = "https://ryanabx.github.io/flatrun"
-repository = "https://github.com/ryanabx/flatrun"
+homepage = "https://linux-packaging-rs.github.io/flatpak-ext"
+repository = "https://github.com/linux-packaging-rs/flatpak-ext"
 license = "MIT"
 
 [lib]

README.md

@@ -1,9 +1,7 @@
-| | |
-| --- | --- |
-| <img src="flatpak-ext.svg" alt="drawing" width="64"/> | <h2>Flatpak-ext: Tools to extend flatpak </h2> |
-
 Flatpak-ext is a binary that allows you to do extra things with flatpak, including:
 
+> **NOTE (2024/09/16):** This project is currently being revived, which will take some time! I've learned a lot about rust since starting this project and I hope to clean it up a lot and add more features and better documentation.
+
 * Running flatpaks without installing them **[Implemented]**
 * More functionality coming soon!
 

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Ryan Brue"]
+language = "en"
+multilingual = false
+src = "src"
+title = "flatpak-ext: Extended tools for Flatpak!"

docs/index.md

@@ -0,0 +1,7 @@
+# Summary
+
+- [Introduction](./index.md)
+
+# Commands
+
+- [flatpak-ext run](./flatpak-ext-run.md)

docs/src/SUMMARY.md

@@ -0,0 +1,5 @@
+# flatpak-ext
+
+https://github.com/linux-packaging-rs/flatpak-ext
+
+> **NOTE (2024/09/16):** This project is currently being revived, which will take some time! I've learned a lot about rust since starting this project and I hope to clean it up a lot and add more features and better documentation.