summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3bfd94a1..5863d242 100644
--- a/README.md
+++ b/README.md
@@ -19,3 +19,42 @@ Ur/Web is Ur plus a special standard library and associated rules for parsing an
This type safety is just the foundation of the Ur/Web methodology. It is also possible to use metaprogramming to build significant application pieces by analysis of type structure. For instance, the demo includes an ML-style functor for building an admin interface for an arbitrary SQL table. The type system guarantees that the admin interface sub-application that comes out will always be free of the above-listed bugs, no matter which well-typed table description is given as input.
The Ur/Web compiler also produces very efficient object code that does not use garbage collection. These compiled programs will often be even more efficient than what most programmers would bother to write in C. For example, the standalone web server generated for the demo uses less RAM than the bash shell. The compiler also generates JavaScript versions of client-side code, with no need to write those parts of applications in a different language.
+
+# Simple Invocation
+
+Here's a simple example of compiling, running, and accessing an application included with the Ur/Web distribution.
+
+```sh
+urweb demo/hello
+demo/hello.exe &
+wget http://localhost:8080/Hello/main -O -
+```
+
+# Simple Installation
+
+The normal UNIX-style build and installation procedure works (where the `make` program needs to be GNU Make, and where `./autogen.sh` must be run first only if starting from a Git checkout rather than a release tarball).
+
+```sh
+./configure
+make
+sudo make install
+```
+
+However, some popular platforms have standard packages for Ur/Web, making installation and uninstallation even easier.
+
+## In Debian, Ubuntu, and Other Related Linux Distributions
+
+```sh
+apt-get install urweb
+```
+
+## In Homebrew for Mac OS
+
+```sh
+brew install urweb
+```
+
+# For More Detail
+
+See [the reference manual](http://www.impredicative.com/ur/manual.pdf).
+Links to packages for other platforms also appear on [the project home page](http://www.impredicative.com/ur/).