summaryrefslogtreecommitdiffstats
path: root/comm/docs/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:44:51 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:44:51 +0000
commit9e3c08db40b8916968b9f30096c7be3f00ce9647 (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /comm/docs/README.md
parentInitial commit. (diff)
downloadthunderbird-9e3c08db40b8916968b9f30096c7be3f00ce9647.tar.xz
thunderbird-9e3c08db40b8916968b9f30096c7be3f00ce9647.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'comm/docs/README.md')
-rw-r--r--comm/docs/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/comm/docs/README.md b/comm/docs/README.md
new file mode 100644
index 0000000000..4ffb083903
--- /dev/null
+++ b/comm/docs/README.md
@@ -0,0 +1,18 @@
+# Building documentation locally
+
+This process will improve over time.
+
+For now, manually create a Python virtual environment and install the
+dependencies:
+
+```shell
+make venv
+```
+
+The virtualenv will be created in **_venv**.
+
+Then to build the documentation:
+
+```shell
+make html
+```