Skip to content

Commit 58faa7c

Browse files
committed
added requirements to usage section
1 parent 8e0ea39 commit 58faa7c

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- This _CHANGELOG.md_ file to keep track of all changes in the project.
1313
- _.gitignore_ file to exclude files and folders from being committed, e.g. folder .idea.
1414
- MIT _LICENSE.md_ file.
15-
- _README.md_ with short project description, install instructions, contributing section and licence link.
15+
- _README.md_ with short project description, usage instructions with requirements and installation, contributing section and licence link.
1616
- Added _onlinesetup_ file that can be used to install project via a network, this file accepts three useful arguments: repository from which to install dockerizer (helps to debug or install own modification), branch (again, helps to debug or install own modification) and install directory in case your project uses same name as default install folder.
1717
- Added _Makefile_, _.make/tools.mk_ for helper constants, _.make/tools/colors.mk_ for CLI colors, _.make/project.mk_ with help target that prints the help message.

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,21 @@ others similar is simplicity: you run single bash command and get power of make
55
files for different purposes. After installing php-dockerizer into your project you can commit only files you want
66
to keep.
77

8-
## Installation
8+
## Usage
9+
10+
Usage of the dockerizer is pretty simple: you run online install command, it fetches changes from install repository to your project and you can commit files you want to keep.
11+
Keep in mind that dockerizer will copy the list of the files and directories to the root of your project:
12+
```text
13+
Makefile
14+
.make
15+
```
16+
* In future dockerizer will be able to detect if there is any file conflicts with your existing files, or
17+
18+
### Requirements
19+
20+
To use dockerizer you need to install [make](https://www.gnu.org/software/make/) and [docker-compose](https://docs.docker.com/compose/install/).
21+
22+
### Installation
923

1024
To install php-dockerizer simply run command:
1125
```shell

0 commit comments

Comments
 (0)