readme

README.md

@@ -30,6 +30,31 @@ Christofforo Suriano:
 *   the correspondence itself is served by
     [edition.suriano.huygens.knaw.nl](https://edition.suriano.huygens.knaw.nl).
 
+# Access the corpus
+
+This repo also contains a [text-fabric](https://github.com/annotation/text-fabric)
+copy of the corpus (in fact, that copy has been instrumental to build the data for the
+website).
+
+This copy contains the transcriptions and thumbnails of the scans.
+
+Here are the express instructions to get going:
+
+1.  install Python
+1.  `pip install 'text-fabric[all]'`
+1.  `tf HuygensING/suriano`
+
+After that a browser window opens with an interface on the Suriano correspondence.
+
+You can also run your own programs on the corpus, through the Text-Fabric API.
+Here is a
+[tutorial to get started](https://nbviewer.org/github/HuygensING/suriano/blob/main/tutorial/start.ipynb).
+
+# Construction of the dataset
+
+Here we describe how we have constructed the Suriano dataset (and how you can replicate
+it).
+
 We proceed as follows:
 
 1.  there are incoming page scans, they are renamed and checked for completeness;
@@ -91,10 +116,3 @@ There are extensive README files in the report directory.
 # How to operate this repo (and the tutorial)
 
 See the [README.md](programs/README.md) in the programs directory.
-
-There you see how to clone this repository. After that, you can follow a tutorial
-here: 
-[start.ipynb](https://nbviewer.org/github/HuygensING/suriano/blob/main/tutorial/start.ipynb)
-
-Note that the online version of the tutorial is not rendered optimally, it is
-recommended to use the clone of the repo on your computer to work through the tutorial.

app/__checkout__.txt

@@ -1,2 +1,2 @@
-v0.2.1
-g9354fb245f67dce66b4f017e29c420b5ae576521
+v1.0
+g820be7a4bee9feb91b18e3953ecea297b86c3ee9

ner/__checkout__.txt

@@ -0,0 +1,2 @@
+v1.0
+g820be7a4bee9feb91b18e3953ecea297b86c3ee9

tf/1.0.2e/__checkout__.txt

@@ -0,0 +1,2 @@
+v1.0
+g820be7a4bee9feb91b18e3953ecea297b86c3ee9

thumb/__checkout__.txt

@@ -0,0 +1,2 @@
+v1.0
+g820be7a4bee9feb91b18e3953ecea297b86c3ee9

tutorial/start.ipynb

@@ -43,44 +43,6 @@
     "See [here](https://annotation.github.io/text-fabric/tf/about/install.html)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "48d000d1-7134-416b-bf7f-58ecebd316d2",
-   "metadata": {
-    "jp-MarkdownHeadingCollapsed": true,
-    "tags": []
-   },
-   "source": [
-    "## Tip\n",
-    "If you start computing with this tutorial, first copy its parent directory to somewhere else,\n",
-    "outside your repository.\n",
-    "If you pull changes from the repository later, your work will not be overwritten.\n",
-    "Where you put your tutorial directory is up to you.\n",
-    "It will work from any directory."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "398a9fa0-5be1-4a97-b6b8-a8ee885b627a",
-   "metadata": {
-    "incorrectly_encoded_metadata": "jp-MarkdownHeadingCollapsed=true",
-    "tags": []
-   },
-   "source": [
-    "## Suriano data\n",
-    "\n",
-    "To get the Suriano data, make sure you are on a computer with a command prompt that can do git operations.\n",
-    "\n",
-    "Make a directory `github.com/HuygensING/suriano` insode your home directory, then, in the command prompt,\n",
-    "navigate to that directory, and from there, give nthe command:\n",
-    "\n",
-    "```\n",
-    "git clone https://github.com/HygensING/suriano\n",
-    "```\n",
-    "\n",
-    "You are well prepared now."
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "aecbc9e9-f969-4ea0-bebb-7864ca5a1290",
@@ -1701,7 +1663,7 @@
     }
    ],
    "source": [
-    "A = use(\"HuygensING/suriano:clone\", checkout=\"clone\", hoist=globals())"
+    "A = use(\"HuygensING/suriano\", hoist=globals())"
    ]
   },
   {