From b0e46a7b1b1c068962c23d90189d03a1a610797b Mon Sep 17 00:00:00 2001
From: Leonid Pryadko <leonid.pryadko@gmail.com>
Date: Thu, 1 Aug 2024 10:17:29 -0700
Subject: [PATCH] documentation update

---
 README.md | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index dc421fa..64ce7ef 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
+---
+title: README
+authors: Leonid P. Pryadko; Weilei Zeng
+date: 2024-08-01
+---
 # dist-m4ri - distance of a classical or quantum CSS code
 
+
+
 ## Overview
 
 The program implements two algorithms for calculating the distance of
@@ -101,12 +108,10 @@ Supported parameters:
 
 ## Compilation
 
-I only tried it with recent `gcc` compilers under linux.  Download the
-distribution from `github` then run from the `dist-m4ri/src` directory
-```sh
-make -j all
-```
-This should compile the executable `dist_m4ri`.
+The program is intended for use with recent `gcc` compilers under
+linux.  Download the distribution from `github` then run from the
+`dist-m4ri/src` directory ```sh make -j all ``` This should compile
+the executable `dist_m4ri`.
 
 The program uses `m4ri` library for binary linear algebra.  To install
 under Ubuntu, run