Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Nov 20, 2023
1 parent 3fe623e commit 66e3717
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ It mainly targets macOS systems (should install on e.g. Ubuntu as well for many
- Well-organized and easy to customize
- The installation and runcom setup is
[tested weekly on real Ubuntu and macOS machines](https://github.com/webpro/dotfiles/actions)
(Big Sur/11, Monterey/12) using [a GitHub Action](./.github/workflows/dotfiles-installation.yml)
(currently on Ventura/13 myself)
(Big Sur/11, Monterey/12 and Ventura/13) using [a GitHub Action](./.github/workflows/dotfiles-installation.yml)
- Supports both Apple Silicon (M1) and Intel chips

## Packages Overview
Expand Down Expand Up @@ -53,16 +52,16 @@ This will clone or download this repo to `~/.dotfiles` (depending on the availab
git clone https://github.com/webpro/dotfiles.git ~/.dotfiles
```

Use the [Makefile](./Makefile) to install the [packages listed above](#packages-overview), and symlink
[runcom](./runcom) and [config](./config) files (using [stow](https://www.gnu.org/software/stow/)):
2. Use the [Makefile](./Makefile) to install the [packages listed above](#packages-overview), and symlink
[runcom](./runcom) and [config](./config) files (using [stow](https://www.gnu.org/software/stow/)):

```bash
cd ~/.dotfiles
make
```

The installation process in the Makefile is tested on every push and every week in this
[GitHub Action](https://github.com/webpro/dotfiles/actions).
Running `make` with the Makefile is idempotent. The installation process in the Makefile is tested on every push and every week in this
[GitHub Action](https://github.com/webpro/dotfiles/actions). Please file an issue in this repo if there are errors.

## Post-Installation

Expand All @@ -75,7 +74,7 @@ The installation process in the Makefile is tested on every push and every week
- Start `Hammerspoon` once and set "Launch Hammerspoon at login"
- `touch ~/.dotfiles/system/.exports` and populate this file with tokens (e.g. `export GITHUB_TOKEN=abc`)

## The `dotfiles` command
## The `dot` command

```
$ dot help
Expand Down

0 comments on commit 66e3717

Please sign in to comment.