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

Commit

Permalink
Documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
kg committed Oct 24, 2015
1 parent eebc933 commit 760f35f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 22 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,19 @@ For live demos and code samples, [visit the website](http://jsil.org).

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

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!

License
=======

Copyright 2011 K. Gadd
Copyright 2011 K. Gadd

Additional contributions by Igor Kiselev and assorted community members.

License: MIT/X11

Replay/Record support & emscripten integration sponsored by Mozilla Corporation
Replay/Record support & Emscripten integration sponsored by Mozilla Corporation

License: MIT/X11

Acknowledgements
Expand All @@ -35,7 +41,13 @@ The Upstream folder also contains:
* 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.
* Win32 build of PNGQuant for optimizing PNG files. (Jef Poskanzer, Greg Roelofs)
* Mono ILASM for CIL tests execution

The following NuGet packages are used:
* Grunt
* Node
* NPM
* NUnit
* NUnit Test Adapter
* FSharp CodeDom

Logo by [John Flynn](http://www.bryneshrimp.com).

Assorted code and test case contributions by the various contributors on the GitHub project page - already too many to list here.
Logo by [John Flynn](http://www.bryneshrimp.com).
21 changes: 4 additions & 17 deletions jsil.org/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<div id="content_box">
<div id="introduction" class="rounded-box">
<h1><img src="images/jsil_48px.png" id="logo">JSIL</h1>
<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>
<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>
</div>
<div id="demos" class="rounded-box">
<h2>Demos</h2>
Expand All @@ -28,37 +28,24 @@ <h2>Demos</h2>
</div>
<div id="codesamples" class="rounded-box">
<h2>Code Samples</h2>
<ul id="sample_list">
<li><a href="samples/foreach.html"><tt>for each</tt></a></li>
<li><a href="samples/multicastdelegates.html"><tt>MulticastDelegate</tt>s</a></li>
<li><a href="samples/refparameters.html"><tt>ref</tt> parameters</a></li>
<li><a href="samples/verbatim.html"><tt>Verbatim</tt> JavaScript</a></li>
<li><a href="samples/closures.html">Closures</a></li>
<li><a href="samples/multidimarrays.html">Multidimensional <tt>Array</tt>s</a></li>
<li><a href="samples/genericsandnested.html">Generics and Nested Types</a></li>
<li><a href="samples/goto.html">Goto</a></li>
<li><a href="samples/structcopyelimination.html">Struct Copy Elimination</a></li>
</ul>
<iframe id="codesample" allowtransparency="true" frameborder="0" sandbox="allow-same-origin allow-scripts" src="about:blank"></iframe>
<span>See <a href="http://try.jsil.org/">try.jsil.org</a>.</span>
</div>
<div id="gettingstarted" class="rounded-box">
<h2>Getting Started</h2>
<h3>Use JSIL</h3>
<ol>
<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>
<li>Build <tt>JSIL.sln</tt> in Visual Studio 2010. <span class="aside">(Express is fine.)</span></li>
<li>Build <tt>JSIL.sln</tt> in Visual Studio 2015. <span class="aside">(Community Edition is sufficient.)</span></li>
<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>
<li>Marvel at convoluted error messages! <span class="aside">(JSIL is still in development. You will hit bugs.)</span></li>
</ol>
<h3>Contribute to JSIL</h3>
<ol>
<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>
<li>Write tests for bugs or new features! <span class="aside">(Without tests, JSIL would always be broken.)</span></li>
<li>Fix broken tests! <span class="aside">(Adding a test for a bug is helpful even if you can't fix it.)</span></li>
<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>
<li>Push to your GitHub fork! <span class="aside">(If you don't, I can't see your awesome changes.)</span></li>
<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>
<li>???</li>
<li>Profit!</li>
</ol>
<h3>Complain about JSIL</h3>
<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>
Expand Down

0 comments on commit 760f35f

Please sign in to comment.