From 6fbfca3814e102f3641aed6bf8aca0a5dd390fc8 Mon Sep 17 00:00:00 2001 From: stdevYuniers Date: Fri, 14 Dec 2018 00:34:55 -0500 Subject: [PATCH] [docker] refs #27 Mod README file to improve doc --- docker/images/dev-cli/Dockerfile | 2 +- docker/images/dev-cli/README.md | 36 +++++++++++++++++++++++++------- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/docker/images/dev-cli/Dockerfile b/docker/images/dev-cli/Dockerfile index 283af01d..248a43c9 100644 --- a/docker/images/dev-cli/Dockerfile +++ b/docker/images/dev-cli/Dockerfile @@ -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 \ diff --git a/docker/images/dev-cli/README.md b/docker/images/dev-cli/README.md index 4fc2c699..9bf913fb 100644 --- a/docker/images/dev-cli/README.md +++ b/docker/images/dev-cli/README.md @@ -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 @@ -26,12 +26,12 @@ 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 \ @@ -39,7 +39,7 @@ $ docker run --rm \ sh -c "cd libskycoin-dotnet; make test" ``` -### Editing code +#### Editing code ```sh $ docker run --rm \ @@ -47,3 +47,25 @@ $ docker run --rm \ 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