Skip to content

Commit

Permalink
docs(readme): update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yunielrc committed Sep 30, 2023
1 parent eecbfe4 commit a65e0a0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ Click on the menu right before `README.md` as shown in the image below.
## About

Are you tired of dealing with dotfiles of tools you are not using, are you tired
of installing a bunch of messy, dirty, and unnecessary configs and executing an
of installing a bunch of messy and dirty configs and executing an
elephant script.

This solution brings you a simple way to declare and install the tools you need along
with its configurations, following the principles of high cohesion and low coupling.
Turn the chaos to order, if you install the configuration, you install the tool
because those belong to the same `package`.
This solution brings you a simple way to declare and install idempotently the tools
you need along with its configurations, following the principles of high cohesion
and low coupling. Turn the chaos to order, if you install the configuration, you
install the tool because those belong to the same `package`.

With this solution you can create multiple selections of packages for your different
needs, for example, you can create a `packages selection` for your laptop, desktop,
Expand Down Expand Up @@ -167,7 +167,7 @@ vim ~/.ydf.env
A `package` is a directory containing files and directories in which some have
a special meaning for the `interpreter`. ydf is an `interpreter`.

### Which are the directories and files with special meaning?
### What are the directories and files with special meaning?

Here is an example of a `package` with 19 directories and files with special
meaning, those are `instructions` that work on any linux distribution:
Expand Down
12 changes: 6 additions & 6 deletions README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Click on the menu right before `README.md` as shown in the image below.
## About

Are you tired of dealing with dotfiles of tools you are not using, are you tired
of installing a bunch of messy, dirty, and unnecessary configs and executing an
of installing a bunch of messy and dirty configs and executing an
elephant script.

This solution brings you a simple way to declare and install the tools you need along
with its configurations, following the principles of high cohesion and low coupling.
Turn the chaos to order, if you install the configuration, you install the tool
because those belong to the same `package`.
This solution brings you a simple way to declare and install idempotently the tools
you need along with its configurations, following the principles of high cohesion
and low coupling. Turn the chaos to order, if you install the configuration, you
install the tool because those belong to the same `package`.

With this solution you can create multiple selections of packages for your different
needs, for example, you can create a `packages selection` for your laptop, desktop,
Expand Down Expand Up @@ -145,7 +145,7 @@ vim ~/.ydf.env
A `package` is a directory containing files and directories in which some have
a special meaning for the `interpreter`. ydf is an `interpreter`.

### Which are the directories and files with special meaning?
### What are the directories and files with special meaning?

Here is an example of a `package` with 19 directories and files with special
meaning, those are `instructions` that work on any linux distribution:
Expand Down

0 comments on commit a65e0a0

Please sign in to comment.