From 9258e004a6b05922d22b0d41de19834b044b4741 Mon Sep 17 00:00:00 2001
From: Marek Kubica <marek@tarides.com>
Date: Mon, 28 Mar 2022 13:49:59 +0200
Subject: [PATCH] Write a README.md when pulling a project

Closes #272
---
 CHANGES.md  |  2 ++
 lib/pull.ml | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/CHANGES.md b/CHANGES.md
index 4ba13a177..44b8c1930 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -8,6 +8,8 @@
 - Show an error message when the solver can't find any version that satisfies
   the requested version constraint in the user's OPAM file (#215, #248,
   @Leonidas-from-XIV)
+- Generate a `duniverse/README.md` file to explain the basics of
+  `opam-monorepo` in the vendored directory (#272, #<PR_NUMBER>, @Leonidas-from-XIV)
 
 ### Changed
 
diff --git a/lib/pull.ml b/lib/pull.ml
index 9eb814cec..706995ada 100644
--- a/lib/pull.ml
+++ b/lib/pull.ml
@@ -50,6 +50,45 @@ let pre_pull_clean_up ~full ~duniverse_dir duniverse =
         Bos.OS.Dir.delete ~must_exist:false ~recurse:true
           Fpath.(duniverse_dir / dir))
 
+let duniverse_documentation = {|\
+duniverse
+=========
+
+This folder contains vendored source code of the dependencies of the project,
+created by the [opam-monorepo](https://github.com/ocamllabs/opam-monorepo)
+tool. You can find the packages and versions that are included in this folder
+in the `.opam.locked` files.
+
+To update the packages do not modify the files and directories by hand, instead
+use `opam-monorepo` to keep the lockfiles and directory contents accurate and
+in sync:
+
+```sh
+opam monorepo lock 
+opam monorepo pull
+```
+
+If you happen to include the `duniverse/` folder in your Git repository make
+sure to commit all files:
+
+```sh
+git add -A duniverse/
+```
+
+For more information check out the homepage and manual of `opam-monorepo`.
+|}
+
+let write_duniverse_dir_documentation ~duniverse_dir =
+  let open Result.O in
+  let file_name = Fpath.v "README.md" in
+  let readme_file = Fpath.(duniverse_dir // file_name) in
+  let* written = Bos.OS.File.with_output readme_file (fun output () ->
+    let content = Bytes.of_string duniverse_documentation in
+    output (Some (content, 0, Bytes.length content))
+    |> Result.ok) ()
+  in
+  written
+
 let duniverse ~full ~root ~global_state ~trim_clone duniverse =
   if List.is_empty duniverse then Ok ()
   else
@@ -58,4 +97,5 @@ let duniverse ~full ~root ~global_state ~trim_clone duniverse =
     let* () = pre_pull_clean_up ~full ~duniverse_dir duniverse in
     let* _created = Bos.OS.Dir.create duniverse_dir in
     let* () = mark_duniverse_content_as_vendored ~duniverse_dir in
+    let* () = write_duniverse_dir_documentation ~duniverse_dir in
     pull_source_dependencies ~global_state ~trim_clone ~duniverse_dir duniverse