Skip to content

Commit 3a49767

Browse files
authored
Update README.md
1 parent eeeb09f commit 3a49767

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# CSharpToJavaScript
22
[Nuget package](https://www.nuget.org/packages/CSharpToJavaScript/) | [CLI](https://github.com/TiLied/CSTOJS_CLI) | [Website](https://tilied.github.io/CSTOJS_Pages/) | [Try it online!](https://tilied.github.io/CSTOJS_Pages/BWA/)
33

4-
This library is a "core" where all the "magic" happens for translating/converting cs into js, using Roslyn. You should use the [CLI](https://github.com/TiLied/CSTOJS_CLI)/dotnet tool, it behaves more or less like dotnet cli, tsc cli, meson. Look for the implementation in [CLI](https://github.com/TiLied/CSTOJS_CLI), [BWA app](https://github.com/TiLied/CSTOJS_BWA) or simple "Hello world" below.
4+
This library is the "core" where all the "magic" happens for translating/converting C# into JS, using Roslyn.
5+
6+
It is recommended to use the [CLI](https://github.com/TiLied/CSTOJS_CLI)/dotnet tool unless you want to write the front-end by yourself. Look for the implementation in the [CLI](https://github.com/TiLied/CSTOJS_CLI), [BWA app](https://github.com/TiLied/CSTOJS_BWA) or the simple "Hello world" example below.
7+
8+
The [CLI](https://github.com/TiLied/CSTOJS_CLI)/dotnet tool is a simple cli front-end that behaves more or less like the dotnet cli, tsc cli, meson.
59

610
## Status
711
test262-parser([master](https://github.com/tc39/test262-parser-tests)): Only JS part (code is not public, yet. ES5 implemented) Total tests: 5363 | Passed: 2824 (52 %) | Failed: 2539
@@ -11,7 +15,7 @@ test262([es5 branch](https://github.com/tc39/test262/tree/es5-tests)): Total tes
1115
**Note: Tests run with "UseVarOverLet" option, using [Jint](https://github.com/sebastienros/jint) as an engine.
1216

1317
## Hello world
14-
- Install [nuget package](https://www.nuget.org/packages/CSharpToJavaScript/) or download a [specific version](https://github.com/TiLied/CSharpToJavaScript/releases).
18+
- Install the [NuGet package](https://www.nuget.org/packages/CSharpToJavaScript/) or download a [specific version](https://github.com/TiLied/CSharpToJavaScript/releases).
1519
- Skip this if using a Nuget package. Follow [the instructions on how to add a project reference](https://learn.microsoft.com/en-us/dotnet/core/tutorials/library-with-visual-studio?pivots=dotnet-7-0#add-a-project-reference).
1620
- In the Main method, add:
1721
```csharp
@@ -28,8 +32,8 @@ Console.WriteLine(file.TranslatedStr);
2832
```javascript
2933
console.log("Hello world.");
3034
```
31-
- For options look at the [code](https://github.com/TiLied/CSharpToJavaScript/blob/master/CSharpToJavaScript/CSTOJSOptions.cs) or on a [website](https://tilied.github.io/CSTOJS_Pages/api/CSharpToJavaScript.CSTOJSOptions.html).
32-
- To specify options (options applying per file):
35+
- For options, look at the [code](https://github.com/TiLied/CSharpToJavaScript/blob/master/CSharpToJavaScript/CSTOJSOptions.cs) or on the [website](https://tilied.github.io/CSTOJS_Pages/api/CSharpToJavaScript.CSTOJSOptions.html).
36+
- To specify options (per file):
3337
```csharp
3438
FileData file = new()
3539
{
@@ -40,8 +44,8 @@ FileData file = new()
4044
```
4145

4246
## Related Repository
43-
- Dotnet tool/CLI for a library: https://github.com/TiLied/CSTOJS_CLI
47+
- Dotnet tool/CLI for this library: https://github.com/TiLied/CSTOJS_CLI
4448
- Tests: https://github.com/TiLied/CSTOJS_Tests
45-
- Library for generating various stuff: https://github.com/TiLied/CSTOJS_GenLib
49+
- Library for generating various things: https://github.com/TiLied/CSTOJS_GenLib
4650
- Website/documentation: https://github.com/TiLied/CSTOJS_Pages
4751
- Blazor WebAssembly app: https://github.com/TiLied/CSTOJS_BWA

0 commit comments

Comments
 (0)