Skip to content

Commit

Permalink
docs(reame): add some benefits
Browse files Browse the repository at this point in the history
  • Loading branch information
yunielrc committed Oct 6, 2023
1 parent caac8cf commit 237e0c7
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 18 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,21 @@
</a>

**_A disruptive dotfiles manager+_**

**_Avoid repetitive work and errors, focus on what matter_**

**_Be ready to work in just a few minutes on your Fresh OS_**

**_Declare your working environment and Automate its configuration_**

**_New member on the team?, reproduce your colleague working environment and start working now_**
</div>

<a href="https://www.producthunt.com/posts/ydf?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-ydf" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=416013&theme=light" alt="ydf - A&#0032;disruptive&#0032;dotfiles&#0032;manager&#0043; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

<img width=95% src="media/ydf-packages.png" alt="ydf-packages">
<a href="https://github.com/yunielrc/.ydf-packages" target="_blank"><img width=95% src="media/ydf-packages.png" alt="ydf-packages"></a>

[**_A working environment declared in a simple directory structure_**](https://github.com/yunielrc/.ydf-packages)

## Table of Contents

Expand Down Expand Up @@ -246,8 +256,9 @@ You can check out some examples of `packages` at: `tests/fixtures/packages`

### What is a YDF Packages Directory

A `packages directory` is a directory that contains a list of `packages` and the
`envsubst.env` file, besides it can have one or more `packages selection` files.
The `packages directory` is the declaration of your working environment. It's a
directory that contains a list of `packages` and the `envsubst.env` file, besides
it can have one or more `packages selection` files.

Here is an example of a `packages directory`:

Expand Down Expand Up @@ -441,23 +452,23 @@ vim ~/.env

#### Install dependencies for Manjaro

The command below install optional and development dependencies for Manjaro
The command below install development dependencies for Manjaro

```sh
make install-opt-manjaro && make install-dev-manjaro
make install-dev-manjaro
```

#### Install dependencies for Ubuntu

The command below install optional and development dependencies for Ubuntu
The command below install development dependencies for Ubuntu

```sh
make install-opt-ubuntu && make install-dev-ubuntu
make install-dev-ubuntu
```

#### Install on Any Linux Distro
#### Install dependencies for Any Linux Distro

For any other linux distribution install optional and development dependencies
For any other linux distribution install development dependencies
manually.

#### Configure vedv
Expand All @@ -472,6 +483,10 @@ Write your code

#### Run Tests

All tests run inside a virtual machine, this guarantee that your OS is never touched.

```sh

The first time the image need to be downloaded and builded for development,
this process take a while, below are shown the download and build time for the
supported Linux distros at 90Mbps:
Expand Down
33 changes: 24 additions & 9 deletions README.md.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,21 @@
</a>

**_A disruptive dotfiles manager+_**

**_Avoid repetitive work and errors, focus on what matter_**

**_Be ready to work in just a few minutes on your Fresh OS_**

**_Declare your working environment and Automate its configuration_**

**_New member on the team?, reproduce your colleague working environment and start working now_**
</div>

<a href="https://www.producthunt.com/posts/ydf?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-ydf" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=416013&theme=light" alt="ydf - A&#0032;disruptive&#0032;dotfiles&#0032;manager&#0043; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

<img width=95% src="media/ydf-packages.png" alt="ydf-packages">
<a href="https://github.com/yunielrc/.ydf-packages" target="_blank"><img width=95% src="media/ydf-packages.png" alt="ydf-packages"></a>

[**_A working environment declared in a simple directory structure_**](https://github.com/yunielrc/.ydf-packages)

## Table of Contents

Expand Down Expand Up @@ -224,8 +234,9 @@ You can check out some examples of `packages` at: `tests/fixtures/packages`

### What is a YDF Packages Directory

A `packages directory` is a directory that contains a list of `packages` and the
`envsubst.env` file, besides it can have one or more `packages selection` files.
The `packages directory` is the declaration of your working environment. It's a
directory that contains a list of `packages` and the `envsubst.env` file, besides
it can have one or more `packages selection` files.

Here is an example of a `packages directory`:

Expand Down Expand Up @@ -371,23 +382,23 @@ vim ~/.env

#### Install dependencies for Manjaro

The command below install optional and development dependencies for Manjaro
The command below install development dependencies for Manjaro

```sh
make install-opt-manjaro && make install-dev-manjaro
make install-dev-manjaro
```

#### Install dependencies for Ubuntu

The command below install optional and development dependencies for Ubuntu
The command below install development dependencies for Ubuntu

```sh
make install-opt-ubuntu && make install-dev-ubuntu
make install-dev-ubuntu
```

#### Install on Any Linux Distro
#### Install dependencies for Any Linux Distro

For any other linux distribution install optional and development dependencies
For any other linux distribution install development dependencies
manually.

#### Configure vedv
Expand All @@ -402,6 +413,10 @@ Write your code

#### Run Tests

All tests run inside a virtual machine, this guarantee that your OS is never touched.

```sh

The first time the image need to be downloaded and builded for development,
this process take a while, below are shown the download and build time for the
supported Linux distros at 90Mbps:
Expand Down

0 comments on commit 237e0c7

Please sign in to comment.