Merge pull request #1287 from herbie-fp/README-pass

Pass on the README, shortening it and matching current recommendations

Author: pavpanchekha

README.md

@@ -3,105 +3,59 @@
 
 Herbie automatically improves the error of floating point expressions.
 Visit [our website](https://herbie.uwplse.org) for tutorials,
-documentation, and an online demo. Herbie has semi-regular releases
-once a year, maintains backwards compatibility, and uses standardized
-formats.
+documentation, and an online demo. Herbie is a joint project of the
+Universities of [Washington](https://uwplse.org) and
+[Utah](https://cpu.cs.utah.edu).
 
 ## Installing
 
-For full details on installing Herbie, please see the
-[documentation](https://herbie.uwplse.org/doc/latest/installing.html).
-
-### Installing from Source
-
-Installing from source requires Racket 8.0 or later,
-  Rust 1.60.0 or later, and supports Windows, macOS, and Linux
-  for various architectures.
-
-Install Racket from [here](https://download.racket-lang.org/). We recommend 
-the official Racket installer over Snap. If your configuration depends on Racket 
-being installed via Snap, you will need to ensure that Herbie and all packages are 
-located in your home directory or another allow-listed directory.
-Install Rust from [here](https://www.rust-lang.org/tools/install).
-In this directory, build Herbie with:
+We recommend installing Herbie from the Racket Package Archive. To do
+so, [install Racket](https://download.racket-lang.org/) and then run:
 
-    make install
-
-You can then run `racket -l herbie` to run Herbie, or run
-`src/main.rkt` directly.
+    raco pkg install --auto herbie
 
-### Installing from the Racket package index
+You can then run `racket -l herbie` to run Herbie. Herbie supports
+Windows, Linux, and macOS on both x86 and AArch64. For full
+instructions, see the
+[documentation](https://herbie.uwplse.org/doc/latest/installing.html).
 
-Use this method for installing Herbie if Rust is not on your system.
-Installing via the Racket package index requires Racket 8.0 or later
-  and supports Windows, macOS, and Linux on x86-64 architectures.
+## Installing from Source
 
-Install Racket from [here](https://download.racket-lang.org/).
-Install Herbie with:
+You can install Herbie from source if you want to participate in
+Herbie development. This requires
+[Racket](https://download.racket-lang.org/) (8.0 or later) and
+[Rust](https://www.rust-lang.org/tools/install) (1.60.0 or later).
+On Linux, avoid the Snap installer for Racket. Then, download the
+this repository and run:
 
-    raco pkg install --auto herbie
+    make install
 
 You can then run `racket -l herbie` to run Herbie, or run
 `src/main.rkt` directly.
 
 ## Running Herbie
 
-For full details on running Herbie, please see the
-[tutorial](https://herbie.uwplse.org/doc/latest/using-web.html).
+You can run Herbie's web interface with:
 
-Herbie's input format is the Scheme-like
-[FPCore](https://fpbench.org/spec/fpcore-1.2.html);
-for example `(1 + x) - x` is written 
+    $ racket -l herbie web
 
-    (FPCore (x) (- (+ 1 x) x))
+For more information on running Herbie, please see the
+[tutorial](https://herbie.uwplse.org/doc/latest/using-web.html).
 
-You can see more examples in `bench/`. To use Herbie, run `herbie
-shell` and enter an FPCore expression:
+You can also use Herbie from the command line:
 
-    $ herbie shell
+    $ racket -l herbie shell
     Herbie 1.3 with seed 1866513483
     Find help on https://herbie.uwplse.org/, exit with Ctrl-D
     herbie> (FPCore (x) (- (+ 1 x) x))
-    (FPCore (x) ... 1)
-
-In this case Herbie's improved, more-accurate expression is the
-constant `1`.
-
-Besides `shell`, Herbie also has a `web` interface, and can be run in
-batch mode on files with the `improve` and `report` commands. Consult
-the [documentation](https://herbie.uwplse.org/doc/latest/options.html).
-for more.
-
-## Helping Out
-
-Herbie is developed as a joint project of the Universities of
-[Washington](https://uwplse.org) and [Utah](https://cpu.cs.utah.edu).
-We use [Github](https://github.com/herbie-fp/herbie) and
-[Trello](https://trello.com/b/lh7b33Dr/herbie) to organize development
-goals.
-
-## Running Tests
-
-Herbie has unit tests for basic functionality, though coverage is far
-from complete. You can run the test suite by downloading the source
-code, changing to the source code directory, and running:
-
-    make install
-    raco test src/
-
-Herbie also contains a large benchmark suite drawn from open source
-projects, examples from users, and numerical analysis textbooks. This
-suite is found in `bench/`. The full test can be run with
-
-    herbie report bench/ report/
-    
-You may see warnings; these are expected. The output is HTML files in
-`report/`. This full test can take a few hours to run. We often test
-Herbie on basic but representative examples with:
-
-    herbie report bench/hamming/ graphs/
+    (FPCore (x)
+      ...
+      1)
 
-This takes approximately 10 minutes.
+Here the input is the program `(1 + x) - x` and the output is `1`. The
+input format is [FPCore](https://fpbench.org/spec/fpcore-1.2.html);
+you can see more examples in `bench/`.
 
-Historic and nightly test results are collected on
-[nightly](https://nightly.cs.washington.edu/reports/herbie/).
+Besides `shell`, Herbie has batch the `improve` and `report` commands.
+The [documentation](https://herbie.uwplse.org/doc/latest/options.html)
+has more details.