Add individual README.md:s for each crate

README.md

@@ -1,8 +1,8 @@
-# rerun
+# Rerun
 [![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rerun-io/rerun/blob/master/LICENSE-MIT)
 [![Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/rerun-io/rerun/blob/master/LICENSE-APACHE)
 
-This repository contains the rerun log SDK and viewer.
+This repository contains the Rerun log SDK, server, and viewer.
 
 ## Setup
 Install Rust: https://rustup.rs/
@@ -16,26 +16,17 @@ Install Rust: https://rustup.rs/
 ./check.sh
 ```
 
-### Other
-You can view higher log levels with `export RUST_LOG=debug` or  `export RUST_LOG=trace`.
-
-
-## Crates
-
-#### `re_comms`
-WebSocket communication tools (encoding, decoding, client, server) between server and viewer.
+## Structure
+The main crates are found in the `crates/` folder, with examples in the `examples/` folder.
 
-#### `re_data_store`
-In-memory storage of log data, indexed for fast fast queries.
+Read about individual examples for details on how to run them.
 
-#### `re_log_types`
-The different types that make up the rerun log format.
+To learn about the viewer, run:
 
-#### `re_viewer`
-`cargo run --release -p re_viewer -- --help`
+```
+cargo run --release -p re_viewer -- --help
+```
 
-Can run both on the web and natively. Talks to the server over WebSockets.
-The viewer can also be used as a library.
 
-#### `re_web_server`
-A binary for serving the web viewer html and wasm.
+### Other
+You can view higher log levels with `export RUST_LOG=debug` or `export RUST_LOG=trace`.

crates/re_comms/README.md

@@ -1 +1 @@
-Library for communication between server and viewer
+WebSocket communication library (encoding, decoding, client, server) between server and viewer.

crates/re_comms/src/server.rs

@@ -1,3 +1,11 @@
+//! The server is a pub-sub architecture.
+//!
+//! Each incoming log message is stored, and sent to any connected client.
+//! Each connecting client is first sent the history of stored log messages.
+//!
+//! In the future thing will be changed to a protocol where the clients can query
+//! for specific data based on e.g. time.
+
 use std::sync::Arc;
 use std::{net::SocketAddr, time::Duration};
 

crates/re_data_store/README.md

@@ -0,0 +1 @@
+In-memory storage of log data, indexed for fast fast queries. Used by `re_viewer`.

crates/re_log_types/README.md

@@ -0,0 +1 @@
+The different types that make up the rerun log format.

crates/re_string_interner/README.md

@@ -0,0 +1,13 @@
+Yet another string interning library.
+
+The main thing that makes this library different is that
+`InternedString` stores the hash of the string, which makes
+using it in lookups is really fast, especially when using `nohash_hasher::IntMap`.
+
+The hash is assumed to be perfect, which means this library accepts the risk of hash collisions!
+
+The interned strings are never freed, so don't intern too many things.
+
+
+## TODO
+This is a utility library and should probably be moved to own repository and be made open soruce..

crates/re_viewer/README.md

@@ -0,0 +1,9 @@
+The Rerun viewer.
+
+This is the main crate with all the GUI.
+
+This is both a library and a binary. Can be compiled both natively for desktop, and as WASM for web.
+
+Talks to the server over WebSockets (using `re_comms`).
+
+`cargo run --release -p re_viewer -- --help`

crates/re_web_server/README.md

@@ -0,0 +1 @@
+Serves the rerun web viewer (`re_viewer` as WASM and HTML) over HTTP.