changeset 113:02ee73a6152f default tip

Make README a bit more helpful
author Lewin Bormann <lbo@spheniscida.de>
date Fri, 02 Oct 2020 13:59:44 +0200
parents 690a9fb49ba1
children
files README.md
diffstat 1 files changed, 4 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/README.md	Wed Jun 15 22:04:18 2016 +0200
+++ b/README.md	Fri Oct 02 13:59:44 2020 +0200
@@ -5,3 +5,7 @@
 the Hard Disk obviously remains the bottleneck. So sometimes, a local `grep` may be
 faster :)
 
+Please use `cargo doc` to inform yourself about the inner workings and how to
+use it. Best is to start with `controller::MRController` and then work through
+the various types from there -- `Sharder`, `Mapper`, `Reducer`, etc.
+