mirrors
/
ctop
mirror of https://github.com/bcicen/ctop.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

add build section to docs

This commit is contained in:
Bradley Cicenas 2017-03-19 22:39:57 +00:00
parent 2b2338805b
commit 82677d52ef
2 changed files with 22 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -42,33 +42,7 @@ docker run -ti --name ctop --rm -v /var/run/docker.sock:/var/run/docker.sock qua
## Building
To build `ctop` from source, ensure you have a recent version of [glide](https://github.com/Masterminds/glide) installed and run:
```bash
git clone https://github.com/bcicen/ctop.git $GOPATH/src/github.com/bcicen/ctop && \
cd $GOPATH/src/github.com/bcicen/ctop && \
make build
```
To build a minimal Docker image containing only `ctop`, follow the build instructions above up through `glide install`, then:
```bash
CGO_ENABLED=0 go build -a
[[ ! -d docker-build ]] && mkdir docker-build
cd docker-build && cp ../ctop ./
cat > Dockerfile <<- "EOF"
FROM scratch
COPY ./ctop /ctop
ENTRYPOINT ["/ctop"]
EOF
docker build -t ctop .
```
Now you can run ctop as above:
```bash
docker run -ti --name ctop --rm -v /var/run/docker.sock:/var/run/docker.sock ctop
```
Build steps can be found [here][build].
## Usage
@ -102,4 +76,5 @@ s | Select container sort field
r | Reverse container sort order
q | Quit ctop
[build]: _docs/build.md
[expanded_view]: _docs/expanded.md

20
_docs/build.md Normal file
View File

@ -0,0 +1,20 @@
# Build
To build `ctop` from source, ensure you have a recent version of [glide](https://github.com/Masterminds/glide) installed and run:
```bash
go get github.com/bcicen/ctop && \
cd $GOPATH/src/github.com/bcicen/ctop && \
make build
```
To build a minimal Docker image containing only `ctop`:
```bash
make image
```
Now you can run your local image:
```bash
docker run -ti --name ctop --rm -v /var/run/docker.sock:/var/run/docker.sock ctop
```