Skip to content

Commit f9afabd

Browse files
committed
updating readme
1 parent 4eb5319 commit f9afabd

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ VS Code uses Electron shell, to write extensions for it using Edge.js use
7171
Sample app that shows how to work with .NET Core using inline code and compiled C# libraries.
7272
https://github.com/agracio/edge-js-quick-start
7373

74+
## Pre-requisites
75+
- Windows: [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version)
76+
7477
## Node.js Support
7578

7679
### edge-js support policy
@@ -172,6 +175,7 @@ module.exports = {
172175
target: 'node',
173176
externals: {
174177
'edge-js': 'commonjs2 edge-js',
178+
'edge-cs': 'commonjs2 edge-cs',
175179
},
176180
node: {
177181
__dirname: true,
@@ -200,6 +204,10 @@ const nextConfig: NextConfig = {
200204
export default nextConfig;
201205
```
202206

207+
## Node.js single executable application packaging
208+
209+
**[`edge-js-pkg`](https://github.com/agracio/edge-js-pkg)**
210+
203211
## Additional languages support
204212

205213
### SQL scripting
@@ -593,10 +601,9 @@ Listen to the [Edge.js podcast on Herdingcode](http://herdingcode.com/herding-co
593601

594602
[Scripting CLR from Node.js](#scripting-clr-from-nodejs)
595603
    [What you need](#what-you-need)
596-
        [Windows](#windows)
597-
        [Linux](#linux)
598-
        [OSX](#osx)
599-
        [Docker](#docker)
604+
        [Windows](#windows-setup)
605+
        [Linux](#linux-setup)
606+
        [OSX](#osx-setup)
600607
    [How to: C# hello, world](#how-to-c-hello-world)
601608
    [How to: integrate C# code into Node.js code](#how-to-integrate-c-code-into-nodejs-code)
602609
    [How to: specify additional CLR assembly references in C# code](#how-to-specify-additional-clr-assembly-references-in-c-code)
@@ -642,25 +649,26 @@ Edge.js runs on Windows, Linux, and OSX and requires supported version of Node.j
642649

643650
**NOTE** there is a known issue with Mono after 4.2.4 that will be addressed in Mono 4.6.
644651

645-
#### Windows
652+
#### Windows setup
646653

647654
* Supported Node.js version
648655
* [.NET 4.6.2](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net462) and/or [.NET Core](https://www.microsoft.com/net/core)
656+
* [Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version)
649657
* to use Python, you also need [IronPython 3.4 or later](https://ironpython.net/download/)
650658
* to use F#, read [Dave Thomas blog post](https://web.archive.org/web/20160323224525/http://7sharpnine.com/posts/i-node-something/)
651659

652660
If you have both desktop CLR and .NET Core installed, read [using .NET Core](#using-net-core) for how to configure Edge to use one or the other.
653661

654-
#### Linux
662+
#### Linux setup
655663

656664
* Supported Node.js version
657-
* .NET Core
665+
* Mono and/or [.NET Core](https://www.microsoft.com/net/core) or Mono
658666
* Follow [Linux setup instructions](#building-on-linux)
659667

660-
#### OSX
668+
#### OSX setup
661669

662670
* Supported Node.js version
663-
* Mono 4.x - 6.x and/or .NET Core
671+
* Mono and/or [.NET Core](https://www.microsoft.com/net/core)
664672
* Follow [OSX setup instructions](#building-on-osx)
665673

666674
### How to: C# hello, world
@@ -1103,7 +1111,7 @@ console.log(counter(null, true)); // prints 14
11031111

11041112
Edge.js enables you to run Python and Node.js in-process.
11051113

1106-
In addition to [platform specific prerequisites](#what-you-need) you need [IronPython 2.7.3](http://ironpython.codeplex.com/releases/view/81726) to proceed.
1114+
In addition to [platform specific prerequisites](#what-you-need) you need [IronPython 3.4](http://ironpython.codeplex.com/releases/) to proceed.
11071115

11081116
#### Hello, world
11091117

0 commit comments

Comments
 (0)