Skip to content

Commit a39f5f1

Browse files
committed
Updating readme file.
Signed-off-by: Stefan J. Wernli <swernli@microsoft.com>
1 parent 91ee89b commit a39f5f1

1 file changed

Lines changed: 15 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@ The goal of this project is to create a PowerShell module for the [Docker Engine
33

44
##Requirements and Goals
55
### Requirements
6-
1. Must work on all versions of Windows Server including Nano Server. This requires that it be Core PowerShell and CoreCLR compliant (see links below).
7-
2. Must follow the Docker Remote API interop and breaking change policy (https://docs.docker.com/engine/breaking_changes/)
8-
3. Must work locally or remotely, with remote following appropriate authentication and security mechanisms (i.e. TLS).
6+
1. Must follow the Docker Remote API interop and breaking change policy (https://docs.docker.com/engine/breaking_changes/)
7+
2. Must work locally or remotely, with remote following appropriate authentication and security mechanisms (i.e. TLS).
98

109
### Goals
11-
* Follow the PowerShell naming and design guidelines (https://msdn.microsoft.com/en-us/library/ms714657(v=vs.85).aspx) including naming.
10+
* Follow the PowerShell design guidelines (https://msdn.microsoft.com/en-us/library/ms714657(v=vs.85).aspx).
1211
* Follow the general design and usage patterns of Docker
12+
* Must remain CoreCLR compliant (see links below). Note that given the current requirements for the Docker.DotNet.X509, the project is still compiling for net46 instead of netstandard. However, once updated implementation for TLS authentication is present, the project will be updated for netstandard and expected to compile and function on Nano Server using the .NET Core CLR and Core Libraries available there.
13+
1314

1415
####.Net Core and Core PowerShell Resources
1516
##### GitHub Repo’s for .Net Core CLR and .Net Core Libraries
@@ -20,8 +21,17 @@ The goal of this project is to create a PowerShell module for the [Docker Engine
2021
* https://blogs.msdn.microsoft.com/dotnet/2016/02/10/porting-to-net-core/
2122
* https://technet.microsoft.com/en-us/library/hh849695.aspx
2223

23-
##Installation
24+
##Compilation
25+
To compile this project, use the dotnet CLI (https://github.com/dotnet/cli) to execute a publish command:
26+
27+
"dotnet publish .\\src\\Docker.PowerShell -o .\\src\\Docker.PowerShell\\bin\\Module\\Docker.PowerShell -r win"
28+
29+
This will produce the PowerShell module at ".\src\Docker.PowerShell\bin\Module\Docker.PowerShell" in the project folder. If Visual Studio is not already installed, the dotnet CLI may require an additional installation of the .NET 4.6 developer pack (https://www.microsoft.com/en-us/download/details.aspx?id=48136).
30+
31+
NOTE: This project uses Docker.DotNet as a git submodule (use "git submodule --help" to view manual pages for submodule). This requires one-time initializtion of the submodule with "git submodule init" and updating via "git submodule update" whenever the proejct targets a new commit of Docker.DotNet.
2432

33+
##Using Visual Studio Code
34+
This project also includes support for Visual Studio Code (https://code.visualstudio.com/, https://github.com/Microsoft/vscode) in the .vscode folder. Using VSCode on the top-level folder, the restore, build, and test tasks will be available. Restore will perform "dotnet restore" across the whole project to reload any dependencies. Build will perform the "dotnet publish" command with the arguments listed in the compilation section above. Test will launch a new powershell window with the module loaded for manual testing.
2535

2636
##High Level Design
2737
The PowerShell module for Docker is built on top of the Docker Engine REST Interface (https://docs.docker.com/engine/reference/api/docker_remote_api/).

0 commit comments

Comments
 (0)