Skip to content

Commit

Permalink
[docker] refs #27 Mod README file to improve doc
Browse files Browse the repository at this point in the history
  • Loading branch information
stdevYuniers committed Dec 14, 2018
1 parent cb8fc62 commit 6fbfca3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docker/images/dev-cli/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ LABEL "org.label-schema.name"="libskycoin-dotnet" \
ENV MONO_VERSION 4.8.0.524
ENV DEBIAN_FRONTEND noninteractive

# Add mono and repo and install necessary packages
# Add mono and dotnet repos and install necessary packages
RUN apt update \
&& apt upgrade -y \
&& apt install -y curl \
Expand Down
36 changes: 29 additions & 7 deletions docker/images/dev-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

## Simple Tags

- [`develop, dind, vscode, vscode-dind` (*docker/images/dev-cli/Dockerfile*)](https://github.com/simelo/libskycoin-dotnet/blob/develop/docker/images/dev-cli/Dockerfile)
- [`develop, dind, vscode, vscode-dind` (*docker/images/dev-cli/Dockerfile*)](https://github.com/simelo/libskycoin-dotnet/blob/develop/docker/images/dev-cli/Dockerfile)

# Libskycoin .NET CLI development image
## Libskycoin .NET CLI development image

This image has the necessary tools to build, test, edit, lint and version the Libskycoin .NET
source code. It comes with Vim editor installed, along with some plugins
to ease go development and version control with git.

# How to use this image
## How to use this image

## Initialize your development environment.
### Initialize your development environment

```sh
$ mkdir src
Expand All @@ -26,24 +26,46 @@ This downloads the libdotnet source to src/libdotnet and changes the owner
to your user. This is necessary, because all processes inside the container run
as root and the files created by it are therefore owned by root.

## Running commands inside the container
### Running commands inside the container

You can run commands by just passing the them to the image. Everything is run
in a container and deleted when finished.

### Running tests
#### Running tests

```sh
$ docker run --rm \
-v ${PWD}/src:/usr/local/src simelotech/skycoindev-dotnet:develop \
sh -c "cd libskycoin-dotnet; make test"
```

### Editing code
#### Editing code

```sh
$ docker run --rm \
-v ${PWD}/src:/usr/local/src simelotech/skycoindev-dotnet:develop \
vim
```

### Use Visual Studio Code

In order to use Visual Studio Code on development, please read carefull
the [documentation of oficial Skycoin Visual Studio Code dev image](https://github.com/skycoin/skycoin/tree/develop/docker/images/dev-vscode#initialize-your-development-environment)

#### Add extensions to Visual Studio Code

Like Skycoin Visual Studio Code dev image, you must pass `VS_EXTENSIONS` environment variable
to the command-line with extensions you prefer.

```sh
$ docker run --rm -it -v /tmp/.X11-unix:/tmp/.X11-unix \
-v $PWD:/go/src/github.com/simelo/libskycoin-dotnet \
-w $GOPATH/src/github.com/simelo/libskycoin-dotnet \
-e DISPLAY=$DISPLAY \
-e VS_EXTENSIONS="ms-python.python rebornix.Ruby" \
simelotech/skycoindev-dotnet:vscode
```

### Build your own images

To be filled

0 comments on commit 6fbfca3

Please sign in to comment.