aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHistorical Source <49599193+historicalsource@users.noreply.github.com>2019-04-16 09:20:20 -0400
committerGitHub <noreply@github.com>2019-04-16 09:20:20 -0400
commit85ab6e5385446cb1ac8cdfe1007cbb372407c76e (patch)
tree99b19f1fb18819e9f89e42bf8d018a8de2b49152
parentd327e7626dbfacc5d634d7d7ee40d95ddb5fddf2 (diff)
downloadsherlock-85ab6e5385446cb1ac8cdfe1007cbb372407c76e.tar.gz
sherlock-85ab6e5385446cb1ac8cdfe1007cbb372407c76e.tar.bz2
sherlock-85ab6e5385446cb1ac8cdfe1007cbb372407c76e.zip
Update README.mdHEADmaster
-rw-r--r--README.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2336f69..7a4c008 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
-# sherlock
+# Sherlock Source Code Collection
+
+Sherlock is a 1987 interactive fiction game written by Bob Bates and published by Infocom.
+
+Further information on Sherlock:
+
+* [Wikipedia](https://en.wikipedia.org/wiki/Sherlock:_The_Riddle_of_the_Crown_Jewels)
+* [The Digital Antiquarian](https://www.filfre.net/2016/04/sherlock-the-riddle-of-the-crown-jewels/)
+* [The Interactive Fiction Database](https://ifdb.tads.org/viewgame?id=j8lmspy4iz73mx26)
+* [The Infocom Gallery](https://gallery.guetech.org/sherlock/sherlock.html)
+* [IFWiki](http://www.ifwiki.org/index.php/Sherlock:_The_Riddle_of_the_Crown_Jewels)
+
+__What is this Repository?__
+
+This repository is a directory of source code for the Infocom game "Sherlock", including a variety of files both used and discarded in the production of the game. It is written in ZIL (Zork Implementation Language), a refactoring of MDL (Muddle), itself a dialect of LISP created by MIT students and staff.
+
+The source code was contributed anonymously and represents a snapshot of the Infocom development system at time of shutdown - there is no remaining way to compare it against any official version as of this writing, and so it should be considered canonical, but not necessarily the exact source code arrangement for production.
+
+__Basic Information on the Contents of This Repository__
+
+It is mostly important to note that there is currently no known way to compile the source code in this repository into a final "Z-machine Interpreter Program" (ZIP) file. There are .ZIP files in some of the Infocom Source Code repositories but they were there as of final spin-down of the Infocom Drive and the means to create them is currently lost.
+
+Throughout its history, Infocom used a TOPS20 mainframe with a compiler (ZILCH) to create and edit language files - this repository is a mirror of the source code directory archive of Infocom but could represent years of difference from what was originally released.
+
+In general, Infocom games were created by taking previous Infocom source code, copying the directory, and making changes until the game worked the way the current Implementor needed. Structure, therefore, tended to follow from game to game and may or may not accurately reflect the actual function of the code.
+
+There are also multiple versions of the "Z-Machine" and code did change notably between the first years of Infocom and a decade later. Addition of graphics, sound and memory expansion are all slowly implemented over time.
+
+__What is the Purpose of this Repository__
+
+This collection is meant for education, discussion, and historical work, allowing researchers and students to study how code was made for these interactive fiction games and how the system dealt with input and processing. It is not considered to be under an open license.
+
+Researchers are encouraged to share their discoveries about the information in this source code and the history of Infocom and its many innovative employees.
+