From c11f77587dd86012f38fc433bd3ea2fe94441d40 Mon Sep 17 00:00:00 2001
From: CompatHelper Julia <compathelper_noreply@julialang.org>
Date: Wed, 15 Dec 2021 00:16:45 +0000
Subject: [PATCH 1/2] CompatHelper: add new compat entry for StaticArrays at
 version 1, (keep existing compat)

---
 Project.toml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Project.toml b/Project.toml
index 0ace367..1e016dd 100644
--- a/Project.toml
+++ b/Project.toml
@@ -17,6 +17,7 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 VegaLite = "112f6efa-9a02-5b7d-90c0-432ed331239a"
 
 [compat]
+StaticArrays = "1"
 julia = "1"
 
 [extras]

From d875f68b2117246aa4d593edfe012c1300806a7d Mon Sep 17 00:00:00 2001
From: fernandopenaranda <49433311+fernandopenaranda@users.noreply.github.com>
Date: Wed, 12 Jan 2022 23:31:16 +0100
Subject: [PATCH 2/2] Update README.md

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/README.md b/README.md
index 9370c9d..3363823 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,53 @@
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://fernandopenaranda.github.io/MBSinBLG.jl/dev)
 [![Build Status](https://github.com/fernandopenaranda/MBSinBLG.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/fernandopenaranda/MBSinBLG.jl/actions/workflows/CI.yml?query=branch%3Amain)
 [![Coverage](https://codecov.io/gh/fernandopenaranda/MBSinBLG.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/fernandopenaranda/MBSinBLG.jl)
+
+For the sake of reproducibility, we show in this repo: the code, the data files, and the plotting functions used to generate the figures in our work: ref.
+
+Remarks:  
+
+0. All the code provided here is written in Julia (v1.0 >)
+1. Our code uses the syntax of [Quantica.jl](https://github.com/pablosanjose/Quantica)
+2. The data files used to build each figure can be either directly accessed at `MBSinBLG/data` or generated as we illustrate in the following:
+
+## Installation
+
+In a Julia terminal: 
+```
+using Pkg
+Pkg.add("https://github.com/fernandopenaranda/MBSinBLG")
+```
+
+## Usage
+
+Generate all data corresponding to each figure and store it in a folder named `/data`
+```
+include("~/MBSinBLG/compute/computefigures.jl")
+```
+The specifications of the machines used in our calculations are shown in said file.
+
+## Plot
+
+We also provide in `~/MBSinBLG/compute/plotfunctions.jl` the plotting code that generates the figures of our manuscript.
+The user just need to specify the path to the .csv file and use the corresponding plotting function, for instance, figure 7 is:
+```
+using CairoMakie, VegaLite, LaTeXStrings, Colors
+using ElectronDisplay
+using MBSinBLG
+pathfig7 = "MBSinBLG/data/fig7"
+fig7plot(pathfig7)
+
+```
+
+## Exported API (additional functions)
+
+In addition, we explicitly export a set of useful functions to obtain information about the physical properties of the system under analysis.
+They are the following:
+```
+nanoribbonS, nanoribbonSA, nanoribbonSZ, Params,  modelS, rectangle_weaklink, rectangle_randombounds_sc, ldosonlattice_averaged_sc
+```
+Detailed information on any of them can be accessed as follows: `?function_name`
+
+
+
+