Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 39 lines (25 sloc) 4.146 kb
26a6dd8 @nikhilk Updated information
authored
1 # Script# Project #
7e8ebce @nikhilk Update readme information
authored
2
e96031d @nikhilk Update readme
authored
3 Script# is a development tool that generates JavaScript by compiling C# source code. It is especially interesting for scripting-in-the-large scenarios that is commonplace in the current generation of HTML5, node.js and script-based Web applications.
7e8ebce @nikhilk Update readme information
authored
4
26a6dd8 @nikhilk Updated information
authored
5 The driving principle behind Script# is that JavaScript is the "assembly language of the Web" ... the idea isn't to dislike JavaScript, but rather appreciate it for its flexibility and ubiquity, while bringing the productivity and familiarity of C# when building large scale (large codebase, large team or project over a longer period) application where stronger tools, more maintainable codebases are of utmost importance. You might have heard of this described as "application scale".
7e8ebce @nikhilk Update readme information
authored
6
26a6dd8 @nikhilk Updated information
authored
7 Specifically, Script# lets you leverage the experience of C# (intellisense, build-time error checking, natural language syntax for OOP constructs), the power Visual Studio IDE and standard .NET tools ecosystem (such as msbuild, refactoring, unit testing, static analysis, code visualization, fxcop). Script# brings all this to you without abstracting the runtime environment - you're still authoring plain-old JavaScript and incorporating the best practices and idioms of JavaScript, just with a different set of tools.
7e8ebce @nikhilk Update readme information
authored
8
26a6dd8 @nikhilk Updated information
authored
9 You can even use Script# to work against other existing frameworks and APIs such as jQuery, jQuery plugins and Knockout, and can be extended to work against other existing script.
7e8ebce @nikhilk Update readme information
authored
10
26a6dd8 @nikhilk Updated information
authored
11 Script# requires .NET 4.0 and Visual Studio 2012. You can also use one of the free Express tools instead such as [Visual Studio 2012 Express for Web](http://www.microsoft.com/visualstudio/eng/downloads#d-express-web) or [Visual Studio 2012 Express for Windows Desktop](http://www.microsoft.com/visualstudio/eng/downloads#d-express-windows-desktop).
7e8ebce @nikhilk Update readme information
authored
12
26a6dd8 @nikhilk Updated information
authored
13 ## More Information ##
14 The following set of links are relevant if you're using Script# and want to learn more or ask questions, or stay up-to-date.
7e8ebce @nikhilk Update readme information
authored
15
26a6dd8 @nikhilk Updated information
authored
16 * [Script# Project page](http://scriptsharp.com)
17 * [Latest released build](http://bit.ly/ssrelease) (packaged as a Visual Studio extension containing Script# project and item templates)
18 * [Issues, suggestions](https://github.com/nikhilk/scriptsharp/issues) here on GitHub. Also, check this out to participate in future design questions, calls for feedback, etc.
19 * For general discussion and Q&A, use [StackOverflow](http://stackoverflow.com/questions/tagged/scriptsharp)
20 * Follow [@scriptsharp](http://twitter.com/scriptsharp) and [@nikhilk](http://twitter.com/nikhilk) on twitter to keep up with updates and announcements.
7e8ebce @nikhilk Update readme information
authored
21
26a6dd8 @nikhilk Updated information
authored
22 The [Script# Wiki](https://github.com/nikhilk/scriptsharp/wiki/Wiki) contains the following bits of information if you're checking out the repository, are interested in creating a private build, or even better, looking to contribute to the project.
7e8ebce @nikhilk Update readme information
authored
23
26a6dd8 @nikhilk Updated information
authored
24 * [Repository Contents](https://github.com/nikhilk/scriptsharp/wiki/Repository)
25 * [Status](https://github.com/nikhilk/scriptsharp/wiki/Status), including roadmap and some thoughts about areas of contribution
f081c80 @nikhilk Update links
authored
26 * [Building, installing and testing](https://github.com/nikhilk/scriptsharp/wiki/Building,-Installing-and-Testing) the sources, and information on using private as well as incremental pre-release builds
26a6dd8 @nikhilk Updated information
authored
27 * [Coding guidelines](https://github.com/nikhilk/scriptsharp/wiki/Coding-Guidelines)
e96031d @nikhilk Update readme
authored
28 * [Release notes](https://github.com/nikhilk/scriptsharp/wiki/Release-Notes) for a changelog and any version to version migration details.
7e8ebce @nikhilk Update readme information
authored
29
26a6dd8 @nikhilk Updated information
authored
30 ### Credits ###
7e8ebce @nikhilk Update readme information
authored
31
32 Script# builds on the excellent Mono.Cecil project. Thanks to Jb Evain.
33
26a6dd8 @nikhilk Updated information
authored
34 Thanks to [all the contributors](https://github.com/nikhilk/scriptsharp/graphs/contributors) who have contributed to Script# over time. Your contributions are welcome, and appreciated. Let me know how you can help - whether its in the form of a feature, a sample, or some evangelizing/spreading the word, or via a suggestion. See the [status page](https://github.com/nikhilk/scriptsharp/wiki/Status) in the wiki for roadmap, plans, and some thoughts about possible contributions.
35
36 ### License ###
7e8ebce @nikhilk Update readme information
authored
37 Copyright (c) 2012, Script# Project.
38 Script# is licensed under the Apache 2.0 License.
Something went wrong with that request. Please try again.