Skip to content

README.md: fix mismatch between repo and app name in install instruct…#1

Open
sysread wants to merge 1 commit intovinibrsl:mainfrom
sysread:patch-1
Open

README.md: fix mismatch between repo and app name in install instruct…#1
sysread wants to merge 1 commit intovinibrsl:mainfrom
sysread:patch-1

Conversation

@sysread
Copy link

@sysread sysread commented Jan 16, 2024

This change to the install instructions is required to use this module in another elixir project.

mix_bina specified bina as the name of the app in mix.exs.

That causes the module to be compiled as bina.app, rather than mix_bina.app, causing a mismatch if you add it as a dep using the name mix_bina. Instead, we can specify the package's home using the git argument to deps, allowing us to name the app bina without losing our ability to find the source.

…ions

The app is generated as `bina.app`, but the repo name is `mix_bina`, which causes a compile error. The `git:` argument to `deps` allows us to specify the repo URI while ensuring that the app name matches the one specified in bina's mix.exs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant