Skip to content

Commit

Permalink
Move getting started section above
Browse files Browse the repository at this point in the history
  • Loading branch information
magnouvean committed Mar 31, 2024
1 parent 798bfe1 commit 8ac95c7
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ to configure KDE Plasma using Nix.
## Table of contents
- [What's supported](#whats-supported)
- [What's not supported](#whats-not-well-supported-at-the-moment)
- [Getting started](#getting-started)
- [Enabling declarative configuration](#make-your-configuration-more-declarative-with-overrideconfig)
- [Capturing existing configuration](#capturing-your-current-configuration-with-rc2nix)
- [Getting started](#getting-started)
- [Contributions and maintenance](#contributions-and-maintenance)
- [Special thanks](#special-thanks)

Expand Down Expand Up @@ -38,6 +38,15 @@ particular:
There may also be more things we aren't aware of. If you find some other
limitations don't hesitate to open an issue or submit a pr.

## Getting started
We provide some examples to help you get started. These are located in the
[example](./example/) directory. Here you in particular can find:
- [An example flake.nix](./example/flake.nix)
- [An example home.nix](./example/home.nix)

With more to come! These should give you some idea how to get started with
`plasma-manager`.

## Make your configuration more declarative with overrideConfig
By default `plasma-manager` will simply write the specified configurations to
various config-files and leave all other options alone. This way settings not
Expand Down Expand Up @@ -80,15 +89,6 @@ the following shell command:
nix run github:pjones/plasma-manager
```

## Getting started
We provide some examples to help you get started. These are located in the
[example](./example/) directory. Here you in particular can find:
- [An example flake.nix](./example/flake.nix)
- [An example home.nix](./example/home.nix)

With more to come! These should give you some idea how to get started with
`plasma-manager`.

## Contributions and Maintenance

This is a community project and we welcome all contributions. If there's enough
Expand Down

0 comments on commit 8ac95c7

Please sign in to comment.