merge about and installation into getting-started
This commit is contained in:
parent
2f88aa46ad
commit
2166b238e2
6 changed files with 72 additions and 137 deletions
|
@ -3,6 +3,68 @@ layout: "@layouts/ConfigLayout.astro"
|
|||
title: "Getting Started"
|
||||
---
|
||||
# {frontmatter.title}
|
||||
> [!NOTE]
|
||||
> Quickshell is still in a somewhat early stage of development.
|
||||
> There will be breaking changes before 1.0, however a migration guide will be provided.
|
||||
|
||||
## Installation
|
||||
|
||||
All packages currently track quickshell's master branch. This may change in the future.
|
||||
|
||||
### Nix
|
||||
The Quickshell repo has an embedded flake.
|
||||
You can use either `git+https://git.outfoxxed.me/outfoxxed/quickshell`
|
||||
or `github:quickshell-mirror/quickshell`.
|
||||
|
||||
```nix
|
||||
{
|
||||
inputs = {
|
||||
nixpkgs.url = "nixpkgs/nixos-unstable";
|
||||
|
||||
quickshell = {
|
||||
url = "git+https://git.outfoxxed.me/outfoxxed/quickshell";
|
||||
|
||||
# THIS IS IMPORTANT
|
||||
# Mismatched system dependencies will lead to crashes and other issues.
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
The package is available as `quickshell.packages.<system>.default`, which you can add to
|
||||
`environment.systemPackages` or `home.packages` if you use home-manager.
|
||||
|
||||
### Arch
|
||||
Quickshell is available from the aur by [mcgoth] under
|
||||
the [quickshell](https://aur.archlinux.org/packages/quickshell) package.
|
||||
|
||||
> [!WARNING]
|
||||
> When using the AUR package, quickshell may break any time Qt is updated.
|
||||
> The AUR gives us no way to actually fix this, but Quickshell will attempt to
|
||||
> warn you if it detects a breakage when updating. If warned of a breakage,
|
||||
> please reinstall the package
|
||||
|
||||
Install using the command below:
|
||||
```sh
|
||||
yay -S quickshell
|
||||
```
|
||||
(or your AUR helper of choice)
|
||||
|
||||
### Fedora
|
||||
Quickshell is available from [errornointernet](https://github.com/errornointernet/)'s
|
||||
Fedora COPR as [errornointernet/quickshell](https://copr.fedorainfracloud.org/coprs/errornointernet/quickshell).
|
||||
|
||||
Install using the command below:
|
||||
```sh
|
||||
sudo dnf copr enable errornointernet/quickshell
|
||||
sudo dnf install quickshell
|
||||
```
|
||||
|
||||
### Manual build
|
||||
See [BUILD.md](https://git.outfoxxed.me/quickshell/quickshell/src/branch/master/BUILD.md)
|
||||
for build instructions and configurations.
|
||||
|
||||
See [Installation](./installation) if Quickshell isn't installed yet.
|
||||
|
||||
## Editor configuration
|
||||
|
@ -58,3 +120,7 @@ more correct code should you chose to use it.
|
|||
> [!NOTE]
|
||||
> Nix users should note that qmlls will not be able to pick up qml modules
|
||||
> that are not in `QML2_IMPORT_PATH`.
|
||||
|
||||
# Next steps
|
||||
|
||||
Create your first configuration by reading the [Intro](./intro).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue