Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 545b18d

Browse files
committedJul 24, 2018
Add to README, update help command
1 parent 28545eb commit 545b18d

File tree

2 files changed

+21
-3
lines changed

2 files changed

+21
-3
lines changed
 

‎README.md

+20-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Raven
2-
A theme manager for linux, currently focusing on i3. Supports multiple different configuration files, and can reload an entire theme on a dime. Fast, easy to use and portable.
2+
A theme manager for linux, currently focusing on i3. Supports multiple different configuration files, and is fast and portable.
33

44
## Installation
55
All you technically require is [cargo](https://github.com/rust-lang/cargo) to be installed.
@@ -21,6 +21,12 @@ The following packages are required for their relevant options:
2121

2222
+ [i3](https://github.com/i3/i3): `wm`
2323

24+
+ [Ranger](https://github.com/ranger/ranger) : `ranger`
25+
26+
+ [Lemonbar](https://github.com/ranger/ranger) : `lemonbar`
27+
28+
+ [Ncmpcpp](https://github.com/arybczak/ncmpcpp) : `ncmpcpp`
29+
2430
You can also download a prebuilt binary from [here](https://github.com/nicohman/raven/releases)
2531

2632
## Usage
@@ -32,8 +38,11 @@ new [theme] : create a new theme
3238
delete [theme] : delete a theme
3339
refresh : load last loaded theme
3440
edit [theme] : initialize editing [theme]
41+
modify [option] : open the currently edited themes's [option] in $EDITOR
3542
add [option] [file] : add option to current theme
43+
cycle {{check|start|stop}} : manage theme cycling daemon
3644
rm [option] : remove option from current theme
45+
info : print info about the theme being currently edited
3746
menu : show theme menu
3847
```
3948
## Configuration
@@ -43,17 +52,25 @@ window_manager: |[window manager in use. Currently only i3 is supported.]|
4352
monitor : |number of monitors available, to tell how many polybars to dupe.|
4453
```
4554

46-
To configure a theme, start off by creating it with `raven new [theme]`. You'll automatically start editing that theme. Run `raven add [option] [file]` to add a specific option. Available options are:
55+
To configure a theme, start off by creating it with `raven new [theme]`. You'll automatically start editing that theme. Run `raven add [option] [file]` to add a specific option. This will copy the indicated file to raven's registry, and run/reload/copy it when the edited theme is loaded or refreshed. Run `raven rm [option]` to remove an option from a theme. Available options are:
4756

4857
+ poly(Polybar)
4958
+ termite(Termite config)
5059
+ wm(window manager config)
5160
+ wall(Wallpaper)
5261
+ xres(Xresources)
5362
+ xres\_m(Xresources, to be merged)
63+
+ ranger(rc.conf)
64+
+ lemonbar(A shell script that should spawn your lemonbar)
65+
+ ncmpcpp(ncmpcpp connfig file)
5466

5567
If you place an i3 config named base\_i3 in ~/.config/raven, the contents of wm for a theme will be appended to it instead of being run on their own. This allows you to have a central config for keyboard shortcuts, and have cosmetics only be stored in the theme.
56-
This will copy the indicated file to raven's registry, and run/reload/copy it when the edited theme is loaded or refreshed. Run `raven rm [option]` to remove an option from a theme.
68+
69+
The lemonbar option should be a shell script that runs lemonbar(s). They will automatically be killed just like polybars when the theme is changed or reloaded.
5770

5871
### Polybar bar names
5972
Up to two polybars will be started, depending on how many monitors you have configured. The bars should be named, in order: `main` and `other`
73+
74+
### Cycle themes
75+
76+
With the cycle command you can control a daemon that will automatically cycle through all of your configured themes. You need to edit `~/.config/raven/time` and place the number of seconds there should be inbetween each cycle into that file in order to use it.

‎src/bin/raven.rs

+1
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,7 @@ fn print_help() {
532532
println!("add [option] [file] : add option to current theme");
533533
println!("rm [option] : remove option from current theme");
534534
println!("cycle {{check|start|stop}} : manage theme cycling daemon");
535+
println!("info : print info about the theme being currently edited");
535536
println!("menu : show theme menu");
536537
}
537538
fn get_home() -> String {

0 commit comments

Comments
 (0)
Please sign in to comment.