Change dir naming during build; add comment about external tool integ…

…rations

Makefile

@@ -1,9 +1,10 @@
 OS=$(shell uname -s | tr '[:upper:]' '[:lower:]')
 prefix ?= $(shell pwd)/build
+ATHENA_POSTFIX=$(OS)-$(version)
 TEST_LOGS_DIR ?= ./logs/tests/
-INSTALLDIR ?= $(prefix)/athena
+INSTALLDIR ?= $(prefix)/athena-$(ATHENA_POSTFIX)
 version=$(shell cat ./version.txt)
-ATHENA_POSTFIX=$(OS)-$(version)
+
 ATHENA_HOME ?= $(shell pwd)
 
 .PHONY: install_external_tools
@@ -31,8 +32,8 @@ build:
 .PHONY: packages
 packages: build
 	mkdir ./packages
-	cd $(prefix) && tar czvf athena-$(ATHENA_POSTFIX).tgz ./athena
-	cd $(prefix) && zip -r athena-$(ATHENA_POSTFIX).zip ./athena/*
+	cd $(prefix) && tar czvf athena-$(ATHENA_POSTFIX).tgz ./athena-$(ATHENA_POSTFIX)
+	cd $(prefix) && zip -r athena-$(ATHENA_POSTFIX).zip ./athena-$(ATHENA_POSTFIX)/*
 	mv $(prefix)/*.tgz ./packages
 	mv $(prefix)/*.zip ./packages
 

README.md

@@ -36,6 +36,28 @@ module Asymmetry {
 
 } 
 ```
+
+## Quickstart
+
+To start using Athena right away, simply download and unpack the latest [release](https://github.com/AthenaFoundation/athena/releases/latest). After doing so, ensure that the `ATHENA_HOME` environment variable is set to the path to the files.
+
+After expanding the packaged release, the contents of the `athena-[platform]-[version]` directory should look like this
+
+```sh
+
+tannr@pop-os: ~/athena-linux-v1.4.1$ ls ./
+
+athena*  build_logs.txt  lib/  util/
+```
+
+It is recommended to also add Athena to your `$PATH` for convenience.
+
+Some features and tests may require an external automated theorem prover and/or SAT solver. The defaults are SPASS and Minisat. These tools are *not* shipped with Athena, so must be installed independently if they are needed (you will need them, for example, if you intend on using the `sat` or `prove` functions within an Athena project).
+
+# Building From Source
+
+For build instructions, please refer to the [Building Athena](https://github.com/AthenaFoundation/athena/wiki/Building-Athena) page in the wiki.
+
 ## Codebase Structure
 Athena is implemented in SML. At its present state, that implementation comprises 80 files, listed in sources.cm.
 
@@ -51,9 +73,6 @@ Note that `athena.sml` is at the top of the graph (it's essentially the 'main' f
 `base.sml` is at the bottom.
 
 
-# Building Athena
-
-For build instructions, please refer to the [Building Athena](https://github.com/AthenaFoundation/athena/wiki/Building-Athena) page in the wiki.
 
 
 # Regression testing

scripts/make_mlton_binary

@@ -1 +1 @@
-mlton @MLton gc-summary -- -output $INSTALLDIR/athena-$ATHENA_POSTFIX -verbose 1 -default-ann 'allowFFI true' -drop-pass deepFlatten -codegen native athena.mlb
+mlton @MLton gc-summary -- -output $INSTALLDIR/athena -verbose 1 -default-ann 'allowFFI true' -drop-pass deepFlatten -codegen native athena.mlb