Factor out submodule checkout and align documentation. Users shall
manually check out the submodule, if needed.
---
README.md | 18 ++++++++++++++----
pasta-prepare | 9 ---------
2 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
index 74f169e..a5f2183 100644
--- a/README.md
+++ b/README.md
@@ -3,11 +3,20 @@ PaStA - Patch Stack Analysis
Getting PaStA
-------------
+
+Clone PaStA and its resources submodule. The resources contain configuration as
+well as results of some sample projects.
+
```
$ git clone https://github.com/lfd/PaStA.git
+$ cd PaStA
+$ git submodule update --init PaStA-resources
```
-**PaStA** runs on *Python3* and comes with the following dependencies:
+Requirements
+------------
+
+**PaStA** requires *Python3* and comes with the following dependencies:
- git
- pygit2
- git-python (for PaStA-resources and patch_descriptions only)
@@ -15,10 +24,11 @@ $ git clone https://github.com/lfd/PaStA.git
- R (tikzDevice, ggplot2)
- fuzzywuzzy + python-levenshtein
-TL;DR
------
+Getting started
+---------------
+- Select the project to analyse by linking the config:
+ `ln -sf PaStA-resources/PreemptRT/PreemptRT.conf ./config`
- Run `./pasta-prepare`
-- Link config `ln -sf PaStA-resources/PreemptRT/PreemptRT.conf ./config`
- Run PaStA `./pasta -h`
Running PaStA
diff --git a/pasta-prepare b/pasta-prepare
index 6470365..e5db7af 100755
--- a/pasta-prepare
+++ b/pasta-prepare
@@ -8,14 +8,5 @@
# This work is licensed under the terms of the GNU GPL, version 2. See
# the COPYING file in the top-level directory.
-function die {
- echo "$@" 1>&2;
- exit -1;
-}
-
-echo "This may take a while. Take a cup of coffe. Really."
-
-git submodule update --init PaStA-resources || die "submodule update failed"
-
cd PaStA-resources
./prepare_projects $1
--
2.14.1
