added README

This commit is contained in:
Valerie Wolfe 2021-06-23 16:33:25 -04:00
parent 85b463b9b8
commit cb5fb6b1ac

26
README.md Normal file
View file

@ -0,0 +1,26 @@
# open
This is a Rust rewrite of my `open` script from my shell scripts. It's written to be faster and more customizable; it now features "local" configs and a zero-operand command, allowing the user to specify how files should be opened differently, and for opening a project, etc.
For example, for
```ini
[open]
# zero-operand command
command = atom .
[.md]
command = typora
[.rs]
command = atom
[filename:.gitignore]
command = vim
shell = true
```
I can use `open` to open the directory in Atom, or I could use `open src/main.rs` to open `main.rs` in Atom, and I can specify these on a per-project basis.
For directories with a local config, any missing values will be filled in by the global config (`~/.config/open.conf`), which means local configs can be shorter.