Skip to content

Commit f00dbe7

Browse files
authored
Merge pull request #985 from PowerShell/DocUpdates
Doc updates
2 parents 31803f6 + 03794a9 commit f00dbe7

File tree

2 files changed

+4
-57
lines changed

2 files changed

+4
-57
lines changed

README.md

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -29,57 +29,11 @@ The functionality in PowerShell Editor Services is already available in the foll
2929
- The [$psEditor API](http://powershell.github.io/PowerShellEditorServices/guide/extensions.html) enables scripting of the host editor
3030
- A full, terminal-based Integrated Console experience for interactive development and debugging
3131

32-
### Important note regarding the .NET APIs in Microsoft.PowerShell.EditorServices.dll
33-
34-
With the 1.0 release of PowerShell Editor Services, we have deprecated the public APIs
35-
of the following classes:
36-
37-
- EditorSession
38-
- LanguageService
39-
- DebugService
40-
- ConsoleService
41-
- AnalysisService
42-
- ExtensionService
43-
- TemplateService
44-
45-
The intended usage model is now to host PowerShell Editor Services within powershell.exe
46-
and communicate with it over named pipes (or Unix domain sockets on macOS & Linux) via the [Language Server Protocol](https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md)
47-
and [Debug Adapter Protocol](https://github.com/Microsoft/vscode-debugadapter-node/blob/master/protocol/src/debugProtocol.ts).
48-
Detailed usage documentation for this module is coming soon!
49-
50-
## Documentation
51-
52-
Check out our **[documentation site](http://powershell.github.io/PowerShellEditorServices)** for information about
53-
how to use this project. You can also read our plans for future feature development by looking at the
54-
**[Development Roadmap](https://github.com/PowerShell/PowerShellEditorServices/wiki/Development-Roadmap)**.
55-
56-
## Installation
57-
58-
**TODO**: Add information about acquiring packages from NuGet and npm once those are available.
59-
6032
## Development
6133

62-
### 1. On Linux or macOS, install PowerShell Core
34+
### 1. Install PowerShell 6+
6335

64-
If you are using Windows, skip this step. If you are using Linux or macOS, you will need to
65-
install PowerShell by following [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
66-
67-
If you are using macOS you will need to download the latest version of OpenSSL. The easiest way to get this is from
68-
[Homebrew](http://brew.sh/). After installing Homebrew execute the following commands:
69-
70-
```
71-
brew update
72-
brew install openssl
73-
mkdir -p /usr/local/lib
74-
ln -s /usr/local/opt/openssl/lib/libcrypto.1.0.0.dylib /usr/local/lib/
75-
ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
76-
```
77-
### 2. On Windows, install the .NET 4.5.2 Targeting Pack
78-
79-
**NOTE: This is only necessary if you don't have Visual Studio installed**
80-
81-
If you try to build the code and receive an error about a missing .NET 4.5.2
82-
Targeting Pack, you should download and install the [.NET Framework 4.5.2 Developer Pack](https://www.microsoft.com/en-us/download/details.aspx?id=42637).
36+
Install PowerShell 6+ with [these instructions](https://github.com/PowerShell/PowerShell#get-powershell).
8337

8438
### 3. Clone the GitHub repository:
8539

@@ -89,9 +43,6 @@ git clone https://github.com/PowerShell/PowerShellEditorServices.git
8943

9044
### 4. Install [Invoke-Build](https://github.com/nightroman/Invoke-Build)
9145

92-
This step requires PowerShellGet, included by default with PowerShell v5 and up
93-
but installable on [PowerShell v3 and v4](https://github.com/PowerShell/PowerShellGet#get-powershellget-module-for-powershell-versions-30-and-40).
94-
9546
```powershell
9647
Install-Module InvokeBuild -Scope CurrentUser
9748
```
@@ -118,8 +69,8 @@ contribute code, documentation, tests, or bug reports, please read our [Contribu
11869

11970
- [Keith Hill](https://github.com/rkeithhill) - [@r_keith_hill](http://twitter.com/r_keith_hill)
12071
- [Patrick Meinecke](https://github.com/SeeminglyScience) - [@SeeminglyScienc](http://twitter.com/SeeminglyScienc)
121-
- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt)
122-
- [David Wilson](https://github.com/daviwil) - [@daviwil](http://twitter.com/daviwil)
72+
- [Tyler Leonhardt](https://github.com/tylerleonhardt) - [@TylerLeonhardt](http://twitter.com/tylerleonhardt)
73+
- [Rob Holt](https://github.com/rjmholt) - no twitter
12374

12475
## License
12576

docs/guide/using_the_dotnet_api.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)