Add README to Rustdoc

Author: Dampfwalze

README.md

@@ -12,35 +12,35 @@ left on the board, ideally in the center location.
 
 ![Solitaire board](https://upload.wikimedia.org/wikipedia/commons/thumb/5/50/Spielzug_von_Solit%C3%A4r.gif/330px-Spielzug_von_Solit%C3%A4r.gif)
 
-- [Solutions](solutions/index.md)
+- [Solutions](https://github.com/Dampfwalze/solitaire_solver/blob/master/solutions/index.md)
 - [Documentation](https://dampfwalze.github.io/solitaire_solver)
 
 This project implements two board representations and two solving schemes,
 namely breadth-first and depth-first search.
 
 ## Board representations
 
-### [`list_board::Board`](src/board/list_board.rs)
+### [`list_board::Board`]
 
 The board is represented with an array of 33 booleans, where each boolean
 represents a location on the board. The array is densly packed, so every element
 of the array represents a location on the board.
 
-```rust
+```rust,no_run
 struct Board([bool; 33]);
 ```
 
-### [`bit_board::Board`](src/board/bit_board.rs)
+### [`bit_board::Board`]
 
 The board is represented with one `u64`, where its bytes represent the rows of
 an 8x8 bit matrix. Only 7x7 locations are actually used up by the board, like
 so:
 
-```rust
+```rust,no_run
 struct Board(u64);
 ```
 
-```
+```text
   0 1 2 3 4 5 6 7 bits
 0 . . ● ● ● . . .
 1 . . ● ● ● . . .
@@ -52,3 +52,6 @@ struct Board(u64);
 7 . . . . . . . .
 bytes
 ```
+
+[`list_board::Board`]: https://dampfwalze.github.io/solitaire_solver/solitaire_solver/board/list_board/struct.Board.html
+[`bit_board::Board`]: https://dampfwalze.github.io/solitaire_solver/solitaire_solver/board/bit_board/struct.Board.html

src/main.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
 #![allow(dead_code)]
 
 use std::{fs, io::Write};