Skip to content

Commit decf155

Browse files
doc: Suggest downloading binaries instead of checking out source
1 parent 882d4db commit decf155

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,53 @@ dockerized <command>
5353

5454
## Installation
5555

56-
- Make sure [Git](https://git-scm.com/downloads) and [Docker](https://docs.docker.com/get-docker/) are installed on your machine.
57-
- Clone this repo anywhere. For example into your home directory:
58-
```shell
59-
git clone https://github.com/datastack-net/dockerized.git
60-
```
61-
- Add the `dockerized/bin` directory to your `PATH`:
62-
- Linux / MacOS:
63-
```bash
64-
export PATH="$PATH:$HOME/dockerized/bin"
56+
- Make sure [Docker](https://docs.docker.com/get-docker/) is installed on your machine.
57+
- Download the latest zip from our [Release Page](https://github.com/datastack-net/dockerized/releases).
58+
- Extract it to a folder, for example your home directory.
59+
- Add the `dockerized/bin` directory to your `PATH`
60+
<details>
61+
<summary>Instructions</summary>
62+
63+
**Linux / MacOS:**
64+
65+
```bash
66+
export PATH="$PATH:$HOME/dockerized/bin"
67+
```
68+
**Windows**
69+
70+
> See: [How to add a folder to `PATH` environment variable in Windows 10](https://stackoverflow.com/questions/44272416)
71+
72+
</details>
73+
74+
### Running from source
75+
76+
You can run dockerized directly from source-code.
77+
78+
<details>
79+
<summary>Installation from Source
80+
</summary>
81+
82+
- Requirements:
83+
- [Git](https://git-scm.com/downloads)
84+
- [Docker](https://docs.docker.com/get-docker/)
85+
- Steps
86+
- Clone the repository
87+
```shell
88+
git clone https://github.com/datastack-net/dockerized.git
89+
```
90+
- Run `dockerized`:
91+
```shell
92+
bin/dockerized --help
6593
```
66-
- Windows
67-
> See: [How to add a folder to `PATH` environment variable in Windows 10](https://stackoverflow.com/questions/44272416)
94+
95+
- The first time you run dockerized, it will compile itself.
96+
- Compilation is done within docker, no dependencies needed.
97+
- To re-compile after changing the source code, run:
98+
- `dockerized --compile` (runs within docker)
99+
- `dockerized --compile=host` (runs on your machine, requires Go 1.17+)
100+
- You do not need to re-compile to add commands. See [Add a command](DEV.md).
101+
102+
</details>
68103

69104

70105
## Usage

0 commit comments

Comments
 (0)