diff --git a/README.md b/README.md new file mode 100644 index 00000000..ad504b19 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Typed Racket + +[![Build Status](https://travis-ci.org/racket/typed-racket)](https://travis-ci.org/racket/typed-racket) + +Typed Racket is Racket's gradually-typed sister language which lets you add +statically-checked type annotations to your programs. For more information, +see the [Typed Racket Guide](http://docs.racket-lang.org/ts-guide/index.html). + +Installation +------------ + +Typed Racket is bundled in the default Racket distribution, which you can download +from Racket's [download page](http://download.racket-lang.org/). + +You can also manually install it from the main [package catalog](http://pkgs.racket-lang.org/) +with the following command: + + `raco pkg install typed-racket` + +Documentation +------------- + + * Guide: http://docs.racket-lang.org/ts-guide/index.html + * Reference: http://docs.racket-lang.org/ts-reference/index.html + +The documentation is also bundled in your local copy of Typed Racket. + +--- + +Copyright (c) 2010-2015 PLT Design Inc. + +This package is distributed under the GNU Lesser General Public +License (LGPL). This means that you can link this package into proprietary +applications, provided you follow the rules stated in the LGPL. You +can also modify this package; if you distribute a modified version, +you must distribute it under the terms of the LGPL, which in +particular means that you must release the source code for the +modified software. See http://www.gnu.org/copyleft/lesser.html +for more information.