From 87a76d67974f890bcc00b3c29bdd14bc7c44a2dc Mon Sep 17 00:00:00 2001 From: Ottatop Date: Mon, 19 Feb 2024 19:35:53 -0600 Subject: [PATCH] Update README, re-add branch name to doc sites --- .github/workflows/ldoc.yml | 1 + .github/workflows/rustdoc.yml | 1 + README.md | 14 ++++++-------- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ldoc.yml b/.github/workflows/ldoc.yml index da4763f..6b4b12d 100644 --- a/.github/workflows/ldoc.yml +++ b/.github/workflows/ldoc.yml @@ -48,4 +48,5 @@ jobs: deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_LUA }} external_repository: pinnacle-comp/lua-reference publish_dir: ../ldoc_gen/.ldoc_gen/doc + destination_dir: ${{ env.BRANCH_NAME }} force_orphan: true diff --git a/.github/workflows/rustdoc.yml b/.github/workflows/rustdoc.yml index 8bde51e..f6984e3 100644 --- a/.github/workflows/rustdoc.yml +++ b/.github/workflows/rustdoc.yml @@ -34,4 +34,5 @@ jobs: deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_RUST }} external_repository: pinnacle-comp/rust-reference publish_dir: ./target/doc + destination_dir: ${{ env.BRANCH_NAME }} force_orphan: true diff --git a/README.md b/README.md index 66f32d2..a09484c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ https://github.com/Ottatop/pinnacle/assets/120758733/c175ba80-9796-4759-92c3-1d7 - [Lua](#lua) - [Lua Language Server completion](#lua-language-server-completion) - [Rust](#rust) - - [API Documentation](#api-documentation) + - [API References](#api-references) - [Controls](#controls) - [Feature Requests, Bug Reports, Contributions, and Questions](#feature-requests-bug-reports-contributions-and-questions) - [Changelog](#changelog) @@ -27,9 +27,7 @@ Pinnacle is a Wayland compositor built in Rust using [Smithay](https://github.co It's my attempt at creating something like [AwesomeWM](https://github.com/awesomeWM/awesome) for Wayland. -It sports extensive configurability through either Lua or Rust, with the ability to add more languages -in the future. And by that I mean other people can do the adding, - I'm already maintaining Lua and Rust lol +It can be configured through either Lua or Rust. > ### More video examples below! >
@@ -90,7 +88,7 @@ TODO: other distros # Building Build the project with: -``` +```sh cargo build [--release] ``` @@ -189,9 +187,9 @@ kill_keybind = { modifiers = ["Ctrl", "Alt", "Shift"], key = "escape" } 4. Copy the [default config](api/rust/examples/default_config/main.rs) to `src/main.rs`. 5. Run Pinnacle! (You may want to run `cargo build` beforehand so you don't have to wait for your config to compile.) -### API Documentation -Lua: https://pinnacle-comp.github.io/pinnacle/main/lua.
-Rust: https://pinnacle-comp.github.io/pinnacle/main/rust.
+### API References +Lua: https://pinnacle-comp.github.io/lua-reference/main.
+Rust: https://pinnacle-comp.github.io/rust-reference/main.
> Documentation for other branches can be reached by replacing `main` with the branch you want.