Skip to content

Commit

Permalink
chore(documentation): document installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Hendrikto committed Mar 29, 2023
1 parent fbe739a commit 29a9870
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions src/ports/sway/templates/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
{{{ basic-heading }}}

# Installation
1. Write the step one
2. Write the step two
... Write the other steps.
[`aura-theme.conf`](aura-theme.conf) has to be included in your Sway configuration. There are several options:

* 1. Save the file (e.g. to `${XDG_CONFIG_HOME}/sway/aura-theme.conf`).
2. Include it in your Sway config (probably `${XDG_CONFIG_HOME}/sway/config`), by putting `include ${XDG_CONFIG_HOME}/sway/aura-theme.conf` somewhere.
* 1. Copy the contents of [`aura-theme.conf`](aura-theme.conf).
2. Insert them somewhere into your Sway config (probably `${XDG_CONFIG_HOME}/sway/config`).
* 1. Save [`aura-theme.conf`](aura-theme.conf) to your Sway drop-in directory (e.g. `${XDG_CONFIG_HOME}/sway/config.d` or `/etc/sway/config.d`).
2. Include the drop-in directory in you Sway config (probably `${XDG_CONFIG_HOME}/sway/config`), by putting `include ${XDG_CONFIG_HOME}/sway/config.d/*` somewhere.

# Contributors
<table>
Expand Down

0 comments on commit 29a9870

Please sign in to comment.