Skip to content

Commit

Permalink
Merge pull request #7 from omar-besbes/development
Browse files Browse the repository at this point in the history
chore: update README.md
  • Loading branch information
omar-besbes authored Feb 16, 2024
2 parents aa226a3 + f3c60b3 commit 2bd3e82
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,10 @@ This directory is added to the path.

### Tests (test/)
The `/test` directory contains tests.
* setup.sh - Sets up a special container with all the dotfiles ready to go and runs `test.sh` inside
* test.sh - Contains tests to be run inside the container
* Dockerfile.local - Contains instructions to build a docker image with dotfiles already installed inside
* Dockerfile.remote - Contains instructions to build a docker image similar to a new user environment and runs the same command in `README.md`.
* docker-compose.yml - Contains a description of the test environments.
There are 2 test environments: one that clones the repository and another that runs the install command in `README.md`
* Dockerfile - Contains instructions to build a docker image of the test environment

### Backups (backups/)
The `/backups` directory gets created when necessary. Any files in `~/` that would have been overwritten during installation get backed up there.
Expand Down

0 comments on commit 2bd3e82

Please sign in to comment.