add a lot of docs and a reference to them in the README

[Mitarbeiter/Tim-Zeitz/stud-rust-base.git] / src / lib.rs

diff --git a/src/lib.rs b/src/lib.rs
index ffa194570017926e90e376ccf61b43da18710622..28f3f9b8b16fa24f0148c48eba49b5611e6df630 100644 (file)
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,5 @@
+//! A small base framework for route planning student projects.
+
 extern crate time as time_crate;
 
 pub mod index_heap;