Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhongXiLu committed Aug 19, 2021
1 parent c1edf86 commit 412f0a5
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
# goplist
[![](https://github.com/ZhongXiLu/goplist/workflows/Go/badge.svg)](https://github.com/ZhongXiLu/goplist/actions?query=workflow%3A%22go%22)

Tool that helps convert macOS preferences to bash commands. I initially wanted to save some of my macOS preferences as bash commands so I can use them in my dotfiles and whenever I would have to setup a new macOS environment, I can easily import my macOS preferences.
Tool that helps convert macOS preferences to bash commands. I initially wanted to save some of my macOS preferences as bash commands so I can use them in my [dotfiles](https://github.com/ZhongXiLu/dotfiles/blob/master/.config/yadm/bootstrap.d/macos.sh) and whenever I would have to setup a new macOS environment, I can easily import my macOS preferences.

# How to Install

// TODO
This is only for macOS of course 😉

### Download executable

- Go to the [latest release](https://github.com/ZhongXiLu/goplist/releases/latest) and download the `goplist` executable.
- Make `goplist` executable: `chmod +x goplist`
- Run `goplist` with `./goplist -h`

### Build locally

Alternatively you can build it yourself:
```bash
git clone [email protected]:ZhongXiLu/goplist.git
cd goplist
go install
goplist -h
```

# How to Run

- Simply run `goplist` in any directory and it will record any changes to your preferences. Note that it may take some time for the OS to write your changes to disk. If you want to keep your current preference, simply toggle (with a small delay in between them) and `goplist` will remember your last choice. After you are done, simply press <kbd>ctrl + c</kbd> and `goplist` will write your preferences to file (by default `macos.sh`).
- Run `goplist -h` for help.
- Currently, `goplist` is *experimental* and might not always work 😛

# Demo

Expand All @@ -20,7 +37,7 @@ Tool that helps convert macOS preferences to bash commands. I initially wanted t
<img src="https://user-images.githubusercontent.com/25816683/130079872-64b27e34-e488-4450-a96c-5ee960a74e82.gif"/>
</p>

- This also works for some other applications, e.g. iTerm2:
- This also works for some other applications, e.g. [iTerm2](https://iterm2.com/):

<p align="center">
<img src="https://user-images.githubusercontent.com/25816683/130079877-e1a48cbf-ea00-45a8-9380-c55d492360d3.gif"/>
Expand Down

0 comments on commit 412f0a5

Please sign in to comment.