Skip to content

Commit 1327f93

Browse files
authored
Warning on dependencies (#1442)
Closes #1441
1 parent dd10dd4 commit 1327f93

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ end
4646
4747
After adding ExDoc as a dependency, run `mix deps.get` to install it.
4848

49+
> 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`.
50+
4951
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:
5052

5153
```elixir

0 commit comments

Comments
 (0)