aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md65
1 files changed, 40 insertions, 25 deletions
diff --git a/README.md b/README.md
index b4839fd..4f3ebc2 100644
--- a/README.md
+++ b/README.md
@@ -1,43 +1,58 @@
-# base16-i3
+# base16-sway
This repository is meant to work with
[chriskempson/base16](https://github.com/chriskempson/base16).
It provides a simple template that can be used with the base16 color schemes to
generate a functional config file for
-[i3/i3](https://github.com/i3/i3),
+[swaywm/sway](https://github.com/swaywm/sway),
a tiling and dynamic window manager.
-To use, you can copy one of the config files in themes/ or use curl. First up, you'll want to generate a starting i3 configuration using `i3-config-wizard`. Then you can
+## Usage
+I imply, that since you are reading this you have already a working sway
+config. If not, [please create
+one](https://wiki.archlinux.org/index.php/Sway#Configuration).
+Sway does not import settings from xresources yet like i3, but it can source a
+file via `include` command. We are going to use this feature here:
+1. Paste `include colorscheme` in your config. `colorscheme` is a reference to
+ file, which will contain your chosen theme.
+2. Paste in your config:
```
-$ curl https://raw.githubusercontent.com/khamer/base16-i3/master/themes/base16-default-dark.config >> ~/.config/i3/config
+# Basic color configuration using the Base16 variables for windows and borders.
+# Property Name Border BG Text Indicator Child Border
+client.focused $base05 $base0D $base00 $base0D $base0D
+client.focused_inactive $base01 $base01 $base05 $base03 $base01
+client.unfocused $base01 $base00 $base05 $base01 $base01
+client.urgent $base08 $base08 $base00 $base08 $base08
+client.placeholder $base00 $base00 $base05 $base00 $base00
+client.background $base07
```
-
-Note that this will create a second bar because it provides a `bar { ... }` section. You can choose which you'd like.
-
-Alternatively, you can fetch just the base16 colors in a format for the i3 config to use them as variables:
-
+3. If you use a statusbar, paste following block in the bar section in your
+ config:
```
-$ curl https://raw.githubusercontent.com/khamer/base16-i3/master/colors/base16-default-dark.config >> ~/.config/i3/config
-```
-
-The benefit of this approach is you can reference the base16 colors through out
-your configuration if you want to customize it further (in particular,
-customize your `bar { ... }`.)
+colors {
+ background $base00
+ separator $base01
+ statusline $base04
-For example, you might want to put the bulk of your configuration in `~/.config/i3/base`, reference the base16 variables, and then use a binding like this:
-
-```
-bindsym $mod+Shift+c exec "cat .config/i3/colors .config/i3/base > .config/i3/config && i3-msg reload"
+ # State Border BG Text
+ focused_workspace $base05 $base0D $base00
+ active_workspace $base05 $base03 $base00
+ inactive_workspace $base03 $base01 $base05
+ urgent_workspace $base08 $base08 $base00
+ binding_mode $base00 $base0A $base00
+}
```
-So you can now run
+`include colorscheme` should be pasted *above* the configs from points 2 and 3.
+An absolutely minimal example is shown in [config file](config).
+
+Now let's create a `colorscheme` file containing a theme. Since the file is
+referred to by name it should be placed in the same directory as your sway
+config. Let's pick default dark theme as example and install it via curl in `~/.config/sway/`:
```
-$ curl https://raw.githubusercontent.com/khamer/base16-i3/master/colors/base16-default-dark.config > ~/.config/i3/colors
+$ curl https://raw.githubusercontent.com/rkubosz/base16-sway/master/themes/base16-default-dark.config > ~/.config/sway/colorscheme
```
+and reload config with **shift+mod+c**.
-And hit **$mod + Shift + c** to load in the new colors.
-
-You can also fetch the separate bar colors and client properties sections of
-the full config from the `bar-colors` and `client-properties` directories.