Skip to content

Commit

Permalink
docs(readme): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yunielrc committed Oct 10, 2023
1 parent d2bea22 commit 7bea380
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ make install-tohome
Instruction | Optional dependency
---------|----------
`@snap` | snapd
`@flatpak` | flatpak
`docker-compose.yml` | docker, docker-compose
`@yay` | yay
`*.plugin.zsh` | yzsh
Expand Down Expand Up @@ -208,7 +209,7 @@ package1
| # those existing in home
├── rootcats/ # Evaluate variables in files and concatenates them with
| # those existing in root
├── dconf.ini # Load dconf settings
├── dconf.ini # Load gnome dconf settings
└── postinstall # Script executed after all instructions
```

Expand Down Expand Up @@ -236,15 +237,15 @@ These instructions are files that are going to be used by a tool. For example
The `package1.plugin.zsh` is a plugin that is going to be installed inside the
YZSH data directory and used by YZSH.

These `instructions` only work for manjaro linux:
These `instructions` only work for archlinux, manjaro linux an other arch distros:

```sh
package2
├── @pacman
└── @yay
```

These `instructions` only work for ubuntu:
These `instructions` only work for debian, ubuntu and other debian distros:

```sh
package3
Expand Down
7 changes: 4 additions & 3 deletions README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ make install-tohome
Instruction | Optional dependency
---------|----------
`@snap` | snapd
`@flatpak` | flatpak
`docker-compose.yml` | docker, docker-compose
`@yay` | yay
`*.plugin.zsh` | yzsh
Expand Down Expand Up @@ -186,7 +187,7 @@ package1
| # those existing in home
├── rootcats/ # Evaluate variables in files and concatenates them with
| # those existing in root
├── dconf.ini # Load dconf settings
├── dconf.ini # Load gnome dconf settings
└── postinstall # Script executed after all instructions
```

Expand Down Expand Up @@ -214,15 +215,15 @@ These instructions are files that are going to be used by a tool. For example
The `package1.plugin.zsh` is a plugin that is going to be installed inside the
YZSH data directory and used by YZSH.

These `instructions` only work for manjaro linux:
These `instructions` only work for archlinux, manjaro linux an other arch distros:

```sh
package2
├── @pacman
└── @yay
```

These `instructions` only work for ubuntu:
These `instructions` only work for debian, ubuntu and other debian distros:

```sh
package3
Expand Down

0 comments on commit 7bea380

Please sign in to comment.