From fa44453c5ed0a3ba37e06845064c4878ba31f9bb Mon Sep 17 00:00:00 2001 From: Stephane Bortzmeyer Date: Mon, 6 Dec 2021 08:14:39 +0100 Subject: [PATCH 1/2] Warning on dependencies. Closes #1441 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 315011e37..8ca9942bc 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,8 @@ end After adding ExDoc as a dependency, run `mix deps.get` to install it. +Attention: at least one ExDoc dependency (earmark_parser) requires Erlang development environment. If you get a message like "/usr/lib/erlang/lib/parsetools-2.3.1/include/yeccpre.hrl: no such file or directory", it means you lack this environment. For instance, on the Debian operating system and its derivatives, you need to `apt install erlang-dev`. + ExDoc will automatically pull in information from your projects, like the application and version. However, you may want to set `:name`, `:source_url` and `:homepage_url` to have a nicer output from ExDoc, such as: ```elixir From e10946197370d8049df71871cc87a1958191f356 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Mon, 6 Dec 2021 08:50:53 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8ca9942bc..ad16a17dc 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ end After adding ExDoc as a dependency, run `mix deps.get` to install it. -Attention: at least one ExDoc dependency (earmark_parser) requires Erlang development environment. If you get a message like "/usr/lib/erlang/lib/parsetools-2.3.1/include/yeccpre.hrl: no such file or directory", it means you lack this environment. For instance, on the Debian operating system and its derivatives, you need to `apt install erlang-dev`. +> Note: Some Operating System distributions split Erlang into multiple packages and at least one ExDoc dependency (`earmark_parser`) requires Erlang development environment. If you get a message like "/usr/lib/erlang/lib/parsetools-2.3.1/include/yeccpre.hrl: no such file or directory", it means you lack this environment. For instance, on the Debian operating system and its derivatives, you need to `apt install erlang-dev`. ExDoc will automatically pull in information from your projects, like the application and version. However, you may want to set `:name`, `:source_url` and `:homepage_url` to have a nicer output from ExDoc, such as: