Skip to content
This repository was archived by the owner on Aug 24, 2022. It is now read-only.

Commit 9e3373c

Browse files
committed
Documentation updates.
1 parent eebc933 commit 9e3373c

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@ For live demos and code samples, [visit the website](http://jsil.org).
77

88
For help on getting started using JSILc, see [the wiki](https://github.com/sq/JSIL/wiki).
99

10+
JSIL is currently in partial maintenance mode (due to time constraints on the maintainer's part), but bug reports and questions are still actively responded to. Pull requests still welcome!
11+
1012
License
1113
=======
1214

13-
Copyright 2011 K. Gadd
15+
Copyright 2011 K. Gadd
16+
17+
Additional contributions by Igor Kiselev and assorted community members.
18+
1419
License: MIT/X11
1520

16-
Replay/Record support & emscripten integration sponsored by Mozilla Corporation
21+
Replay/Record support & Emscripten integration sponsored by Mozilla Corporation
22+
1723
License: MIT/X11
1824

1925
Acknowledgements
@@ -35,7 +41,13 @@ The Upstream folder also contains:
3541
* A specific version of the NUnit.Framework assembly, used by the automated tests. This ensures that they compile correctly regardless of which version of NUnit you have installed.
3642
* Win32 build of PNGQuant for optimizing PNG files. (Jef Poskanzer, Greg Roelofs)
3743
* Mono ILASM for CIL tests execution
44+
45+
The following NuGet packages are used:
46+
* Grunt
47+
* Node
48+
* NPM
49+
* NUnit
50+
* NUnit Test Adapter
51+
* FSharp CodeDom
3852

39-
Logo by [John Flynn](http://www.bryneshrimp.com).
40-
41-
Assorted code and test case contributions by the various contributors on the GitHub project page - already too many to list here.
53+
Logo by [John Flynn](http://www.bryneshrimp.com).

jsil.org/index.html

+3-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<div id="content_box">
1212
<div id="introduction" class="rounded-box">
1313
<h1><img src="images/jsil_48px.png" id="logo">JSIL</h1>
14-
<p>JSIL is a compiler that transforms .NET applications and libraries from their native executable format - <a href="http://en.wikipedia.org/wiki/Common_Intermediate_Language">CIL bytecode</a> - into standards-compliant, cross-browser JavaScript. You can take this JavaScript and run it in a web browser or any other modern JavaScript runtime. Unlike other cross-compiler tools targeting JavaScript, JSIL produces readable, easy-to-debug JavaScript that resembles the code a developer might write by hand, while still maintaining the behavior and structure of the original .NET code. Because JSIL transforms bytecode, it can support most .NET-based languages - C# to JavaScript and VB.NET to JavaScript work right out of the box.</p>
14+
<p>JSIL is a compiler that transforms .NET applications and libraries from their native executable format - <a href="http://en.wikipedia.org/wiki/Common_Intermediate_Language">CIL bytecode</a> - into standards-compliant, cross-browser JavaScript. You can take this JavaScript and run it in a web browser or any other modern JavaScript runtime. Unlike other cross-compiler tools targeting JavaScript, JSIL produces easy-to-debug JavaScript while still maintaining the behavior and structure of the original .NET code. Because JSIL transforms bytecode, it can support most .NET-based languages - C# to JavaScript and VB.NET to JavaScript work right out of the box, and F# is partially supported. Nearly the entire feature set of the .NET runtime (including pointers and P/Invoke) is supported, and most of the open-source BCL is translatable by the compiler.</p>
1515
</div>
1616
<div id="demos" class="rounded-box">
1717
<h2>Demos</h2>
@@ -46,19 +46,17 @@ <h2>Getting Started</h2>
4646
<h3>Use JSIL</h3>
4747
<ol>
4848
<li>Clone the repository using Git, from '<tt>https://github.com/sq/JSIL.git</tt>'. <span class="aside">(Make sure you pull the submodules!)</span></li>
49-
<li>Build <tt>JSIL.sln</tt> in Visual Studio 2010. <span class="aside">(Express is fine.)</span></li>
49+
<li>Build <tt>JSIL.sln</tt> in Visual Studio 2015. <span class="aside">(Community Edition is sufficient.)</span></li>
5050
<li>Run <tt>JSILc.exe</tt> on your application. <span class="aside">(<a href="https://github.com/sq/JSIL/wiki">See the wiki for help</a>.)</span></li>
5151
<li>Marvel at convoluted error messages! <span class="aside">(JSIL is still in development. You will hit bugs.)</span></li>
5252
</ol>
5353
<h3>Contribute to JSIL</h3>
5454
<ol>
5555
<li><a href="https://github.com/sq/JSIL">Fork JSIL on GitHub</a>. <span class="aside">(Working locally from a clone is okay too.)</span></li>
5656
<li>Write tests for bugs or new features! <span class="aside">(Without tests, JSIL would always be broken.)</span></li>
57-
<li>Fix broken tests! <span class="aside">(Adding a test for a bug is helpful even if you can't fix it.)</span></li>
57+
<li>Fix broken tests! Tests can be run from VS2015's integrated testing tools.<span class="aside">(Adding a test for a bug is helpful even if you can't fix it.)</span></li>
5858
<li>Push to your GitHub fork! <span class="aside">(If you don't, I can't see your awesome changes.)</span></li>
5959
<li><a href="https://github.com/sq/JSIL/pull/new/master">Create a pull request on GitHub</a>. <span class="aside">(Submitting a patch is okay too.)</span></li>
60-
<li>???</li>
61-
<li>Profit!</li>
6260
</ol>
6361
<h3>Complain about JSIL</h3>
6462
<p>Not everybody has time to write code! That's okay. You can <a href="https://github.com/sq/JSIL/issues">report issues</a>, or just talk about JSIL on the internet or something!</p>

0 commit comments

Comments
 (0)