Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md and INSTALL.md #44

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README.md and INSTALL.md #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Updating mj2
## Updating mmj2


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
~~~~
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down