From 3c24295ebfe245782f893ecbca19eae1b37ed7f8 Mon Sep 17 00:00:00 2001 From: "David A. Wheeler" Date: Tue, 16 Jun 2020 17:23:24 -0400 Subject: [PATCH] Improve README.md and INSTALL.md Fix the markdown links in README.md, and extend the INSTALL.md file (especially with more MacOS instructions and info on how to update mmj2). Signed-off-by: David A. Wheeler --- INSTALL.md | 27 ++++++++++++++++++++++++++- README.md | 18 ++++++++++-------- 2 files changed, 36 insertions(+), 9 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 5a5c691..07c8233 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -315,7 +315,32 @@ comply with Oracle's licenses if you do this (the free one, in particular, has many restrictions on how you can legally use it). +#### Install git and a good text editor + +Install git. The easiest way to do this is to first install +Homebrew; go to the [Homebrew web page](https://brew.sh/) +if you have not already done that. + +Then install git with: + +~~~~ +brew install +~~~~ + +Apple MacOS comes with "TextEdit" which you can use as a text editor. +You can install many others. + #### The rest -Now that you have Java installed, +Now that you have Java and git installed, follow the Linux/Unix/Cygwin instructions above. + +## Updating mj2 + +If you use git to install mmj2, as we currently recommend, you can +update to the current version of mmj2 by doing: + +~~~~ +cd mmj2 +git pull +~~~~ diff --git a/README.md b/README.md index cce5385..e8a0cef 100644 --- a/README.md +++ b/README.md @@ -9,24 +9,26 @@ mmj2 was originally developed by Mel O'Cat 2005-2011. This version has been further modified by Mario Carneiro and David A. Wheeler. This program is released under the terms of the GNU General Public License Version 2 or any later version -(SPDX license identifier GPL-2.0-or-later); see [LICENSE.TXT][]. +(SPDX license identifier GPL-2.0-or-later); see [the license](LICENSE.txt). ## Installation -Refer to [INSTALL.md][] for instructions on how to install mmj2. +Refer to [the installation instructions](INSTALL.md) for how to install mmj2. This includes installing a Java runtime if you don't already have one (since mmj2 requires a Java runtime). -## Interactive Tutorial - -Once you have installed mmj2, if you've not used mmj2 before, -be sure to try the interactive tutorial (which ought to take about an hour). - [mmj2 Proof Assistant Tutorial][6] - ## Quick Start See [Quick Start](quickstart.md) if you want to quickly get running. +## Interactive Tutorial + +Once you have installed mmj2, if you've not used mmj2 before, +be sure to try the mmj2 Proof Assistant Tutorial. +This is an interactive tutorial which ought to take about an hour. +If you just want to watch it, you can go to Youtube and watch a +[Walkthrough of the tutorial in mmj2](https://www.youtube.com/watch?v=87mnU1ckbI0). + ## More information Once you've installed mmj2, the following pages may be useful: