Miroirs/pinnacle
1
0
Fork 0
mirror of https://github.com/pinnacle-comp/pinnacle.git synced 2024-12-25 09:59:21 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README, re-add branch name to doc sites

Browse source
This commit is contained in:
Ottatop 2024-02-19 19:35:53 -06:00
parent 0717a18206
commit 87a76d6797
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/ldoc.yml vendored
View file

@ -48,4 +48,5 @@ jobs:
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_LUA }} deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_LUA }}
external_repository: pinnacle-comp/lua-reference external_repository: pinnacle-comp/lua-reference
publish_dir: ../ldoc_gen/.ldoc_gen/doc publish_dir: ../ldoc_gen/.ldoc_gen/doc
destination_dir: ${{ env.BRANCH_NAME }}
force_orphan: true force_orphan: true

1
.github/workflows/rustdoc.yml vendored
View file

@ -34,4 +34,5 @@ jobs:
deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_RUST }} deploy_key: ${{ secrets.DOCS_DEPLOY_KEY_RUST }}
external_repository: pinnacle-comp/rust-reference external_repository: pinnacle-comp/rust-reference
publish_dir: ./target/doc publish_dir: ./target/doc
destination_dir: ${{ env.BRANCH_NAME }}
force_orphan: true force_orphan: true

14
README.md
View file

@ -16,7 +16,7 @@ https://github.com/Ottatop/pinnacle/assets/120758733/c175ba80-9796-4759-92c3-1d7
- [Lua](#lua) - [Lua](#lua)
- [Lua Language Server completion](#lua-language-server-completion) - [Lua Language Server completion](#lua-language-server-completion)
- [Rust](#rust) - [Rust](#rust)
- [API Documentation](#api-documentation) - [API References](#api-references)
- [Controls](#controls) - [Controls](#controls)
- [Feature Requests, Bug Reports, Contributions, and Questions](#feature-requests-bug-reports-contributions-and-questions) - [Feature Requests, Bug Reports, Contributions, and Questions](#feature-requests-bug-reports-contributions-and-questions)
- [Changelog](#changelog) - [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) It's my attempt at creating something like [AwesomeWM](https://github.com/awesomeWM/awesome)
for Wayland. for Wayland.
It sports extensive configurability through either Lua or Rust, with the ability to add more languages It can be configured through either Lua or Rust.
in the future. <sup>And by that I mean other people can do the adding,
I'm already maintaining Lua and Rust lol</sup>
> ### More video examples below! > ### More video examples below!
> <details> > <details>
@ -90,7 +88,7 @@ TODO: other distros
# Building # Building
Build the project with: Build the project with:
``` ```sh
cargo build [--release] 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`. 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.) 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 ### API References
<b>Lua: https://pinnacle-comp.github.io/pinnacle/main/lua.<br> <b>Lua: https://pinnacle-comp.github.io/lua-reference/main.<br>
Rust: https://pinnacle-comp.github.io/pinnacle/main/rust.</b> Rust: https://pinnacle-comp.github.io/rust-reference/main.</b>
> Documentation for other branches can be reached by replacing `main` with the branch you want. > Documentation for other branches can be reached by replacing `main` with the branch you want.