Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated information

  • Loading branch information...
commit 26a6dd8b3432e5e2f414708feb3b51c17e634b36 1 parent 4d7222d
Nikhil Kothari authored
Showing with 21 additions and 21 deletions.
  1. +21 −21 Readme.md
42 Readme.md
View
@@ -1,37 +1,37 @@
-# Welcome to the Script# Project #
+# Script# Project #
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 and script-based Web applications.
-Script# lets you leverage the productivity of C# (intellisense, build-time error checking, natural language syntax), and the power Visual Studio IDE and standard .NET tools (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 script, just with a different set of tools.
+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".
-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.
-
-Script# requires .NET 4.0 and Visual Studio 2010 or (the free) Visual Web Developer Express 2010.
+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.
-To learn more about Script#, check out the project site, [http://www.scriptsharp.com](http://www.scriptsharp.com). You can also follow [@scriptsharp](http://twitter.com/scriptsharp) on twitter for the latest announcements. If you'd like, you can also ask general questions about using script# on [stack overflow](http://stackoverflow.com/questions/tagged/script%23).
-
-## Current Status ##
+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.
-Script# has been an ongoing project for many years, and as such is quite usable. It is in fact used across a number of large (and some *very* large) and successful deployed projects, both within Microsoft and amongst other developers.
+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).
-One area where Script# lacks is good and current documentation. While this is addressed (please stay tuned), be sure to check out the [sample apps](https://github.com/nikhilk/scriptsharp/tree/master/samples) in the repository.
+## More Information ##
+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.
-There is always room for further improvement that range from bug fixes to full-blown features. If you have feedback or suggestions, be sure to [file an issue](https://github.com/nikhilk/scriptsharp/issues).
+* [Script# Project page](http://scriptsharp.com)
+* [Latest released build](http://bit.ly/ssrelease) (packaged as a Visual Studio extension containing Script# project and item templates)
+* [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.
+* For general discussion and Q&A, use [StackOverflow](http://stackoverflow.com/questions/tagged/scriptsharp)
+* Follow [@scriptsharp](http://twitter.com/scriptsharp) and [@nikhilk](http://twitter.com/nikhilk) on twitter to keep up with updates and announcements.
-The current release is v0.7.4. The next release, v0.7.5 is slated to be a bug fix release. Thereafter work will begin on a major update that brings about a much improved script generation model that incorporates a number of learnings over the years.
+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.
+* [Repository Contents](https://github.com/nikhilk/scriptsharp/wiki/Repository)
+* [Status](https://github.com/nikhilk/scriptsharp/wiki/Status), including roadmap and some thoughts about areas of contribution
+* [Building and testing](https://github.com/nikhilk/scriptsharp/wiki/Building-and-Testing) the sources, and information on using private as well as incremental pre-release builds
+* [Coding guidelines](https://github.com/nikhilk/scriptsharp/wiki/Coding-Guidelines)
-## Credits ##
+### Credits ###
Script# builds on the excellent Mono.Cecil project. Thanks to Jb Evain.
-## License ##
+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.
+
+### License ###
Copyright (c) 2012, Script# Project.
Script# is licensed under the Apache 2.0 License.
-
-## Contributing ##
-
-You are welcome to contribute to script# by reporting bugs/issues, creating and evangelizing samples and success stories, as well as with code.
-Contributors implicity grant all rights to any code updates/additions made to the project for inclusion under the Apache 2 license.
-
-Fork away, and create a pull request! For any major functionality you'd like to add, it might be good to discuss and share thoughts to better coordinate.
Please sign in to comment.
Something went wrong with that request. Please try again.