From 0ef4e90f9a3651dfbc66358dbd99a1b07f493929 Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Wed, 10 Feb 2016 15:27:37 -0800 Subject: [PATCH] Add readme to Linux.Host --- src/Microsoft.PowerShell.Linux.Host/README.md | 25 +++++++++++++++++++ .../update-content.sh | 10 -------- 2 files changed, 25 insertions(+), 10 deletions(-) create mode 100644 src/Microsoft.PowerShell.Linux.Host/README.md diff --git a/src/Microsoft.PowerShell.Linux.Host/README.md b/src/Microsoft.PowerShell.Linux.Host/README.md new file mode 100644 index 000000000..9c8e1e197 --- /dev/null +++ b/src/Microsoft.PowerShell.Linux.Host/README.md @@ -0,0 +1,25 @@ +# Core PowerShell Host + +This host is based off the infamous `host06` example. It relies only on managed +code, and is cross-platform. It needs a fair bit of work, but it loads +profiles, has tab-completion, and can be used to debug PowerShell scripts. + +## Executable + +The `bin/powershell[.exe]` executable for Core PowerShell is built by this +project, as it is the top dependency of the graph, and has `emitEntryPoint: +true`, meaning a native executable is produced automatically by CLI (no need to +own a separate native host). It is also the project that deploys the `ps1xml` +types and formatting files, as well as the default profile and the included +PowerShell modules. + +Note that many of these should probably live with System.Management.Automation, +but we're waiting on a bug fix from CLI to move them. + +## update-content.sh + +This script is used to update our current tree's files with those that live in +`src/monad`. We only need to update them when new changes are merged from +Source Depot, and the build scripts are much simpler without this logic. With +the files living here, the `content` key in the `project.json` handles the +deployment for us in a cross-platform manner. diff --git a/src/Microsoft.PowerShell.Linux.Host/update-content.sh b/src/Microsoft.PowerShell.Linux.Host/update-content.sh index 932e45ccb..967d10f98 100755 --- a/src/Microsoft.PowerShell.Linux.Host/update-content.sh +++ b/src/Microsoft.PowerShell.Linux.Host/update-content.sh @@ -1,15 +1,5 @@ #!/usr/bin/env bash -# This script is used to update our current tree's files with those that live -# in `src/monad`. We only need to update them when new changes are merged from -# Source Depot, and the build scripts are much simpler without this logic. With -# the files living here, the `content` key in the `project.json` handles the -# deployment for us in a cross-platform manner. - -# Note that many of these should probably live with -# System.Management.Automation, but we're waiting on a bug fix from CLI to move -# them. - # Types files cp ../monad/monad/miscfiles/types/CoreClr/types.ps1xml . cp ../monad/monad/miscfiles/types/CoreClr/typesv3.ps1xml .