From ef68bc7988274d2a66a6545202bde041e4f407c3 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (h)" <j.wuttke@fz-juelich.de>
Date: Fri, 20 Nov 2020 11:42:28 +0100
Subject: [PATCH] Update auto/README.md
---
cmake/BornAgain/Directories.cmake | 2 +-
cmake/configurables/auto_README.in | 20 -------------------
.../configurables/auto_README.in.md | 16 ++++++++-------
3 files changed, 10 insertions(+), 28 deletions(-)
delete mode 100644 cmake/configurables/auto_README.in
rename auto/README.md => cmake/configurables/auto_README.in.md (60%)
diff --git a/cmake/BornAgain/Directories.cmake b/cmake/BornAgain/Directories.cmake
index 33fec34c1eb..cdf0e39f7cf 100644
--- a/cmake/BornAgain/Directories.cmake
+++ b/cmake/BornAgain/Directories.cmake
@@ -41,7 +41,7 @@ set(TEST_OUTPUT_DIR_PY_PERSIST ${TEST_OUTPUT_DIR}/PyPersist)
set(TEST_OUTPUT_DIR_PY_STD ${TEST_OUTPUT_DIR}/PyStd)
set(TEST_OUTPUT_DIR_STD ${TEST_OUTPUT_DIR}/Std)
-configure_file("${CONFIGURABLES_DIR}/auto_README.in" "${CMAKE_SOURCE_DIR}/auto/README" @ONLY)
+configure_file("${CONFIGURABLES_DIR}/auto_README.in.md" "${CMAKE_SOURCE_DIR}/auto/README.md" @ONLY)
file(MAKE_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
file(MAKE_DIRECTORY ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}/bornagain)
diff --git a/cmake/configurables/auto_README.in b/cmake/configurables/auto_README.in
deleted file mode 100644
index 6a4c2faa77c..00000000000
--- a/cmake/configurables/auto_README.in
+++ /dev/null
@@ -1,20 +0,0 @@
-This directory, auto, contains files that are automatically
-generated by tools other than CMake, Make, and the compiler.
-
-They are distributed as part of the source archive. A user
-who just wants to compile BornAgain should consider the
-contents of this directory as part of the source.
-
-A developer, on the other hand, will sooner or later need
-to regenerate some or all sources contained in this directory.
-For this, use the command top-level cmake command with option
--DAUTOGENERATE=ON, or with more specific options like
--DBORNAGAIN_GENERATE_BINDINGS=ON.
-
-Contents of this directory:
-
-Doc/man:
- Unix man page in troff format, generated by pod2man.
-
-Wrap:
- Python wrapper, generated by Doxygen and Swig.
diff --git a/auto/README.md b/cmake/configurables/auto_README.in.md
similarity index 60%
rename from auto/README.md
rename to cmake/configurables/auto_README.in.md
index 6a4c2faa77c..5bd3a08832b 100644
--- a/auto/README.md
+++ b/cmake/configurables/auto_README.in.md
@@ -1,4 +1,6 @@
-This directory, auto, contains files that are automatically
+#### Directory auto/
+
+This directory contains files that are automatically
generated by tools other than CMake, Make, and the compiler.
They are distributed as part of the source archive. A user
@@ -8,13 +10,13 @@ contents of this directory as part of the source.
A developer, on the other hand, will sooner or later need
to regenerate some or all sources contained in this directory.
For this, use the command top-level cmake command with option
--DAUTOGENERATE=ON, or with more specific options like
--DBORNAGAIN_GENERATE_BINDINGS=ON.
+`-DAUTOGENERATE=ON`, or with more specific options like
+`-DBORNAGAIN_GENERATE_BINDINGS=ON`.
Contents of this directory:
-Doc/man:
- Unix man page in troff format, generated by pod2man.
+`Doc/man`
+: Unix man page in troff format, generated by pod2man.
-Wrap:
- Python wrapper, generated by Doxygen and Swig.
+`Wrap`
+: Python wrapper, generated by Doxygen and Swig.
--
GitLab