We should keep it according to the standard and recommended way of indenting data structures in Elixir today, which is the format currently generated by the README.
*José Valim* www.plataformatec.com.br Skype: jv.ptec Founder and Director of R&D On Fri, Jul 8, 2016 at 8:14 PM, Wiebe-Marten Wijnja < [email protected]> wrote: > When you create a new project using Mix, it generates a standard > *README.md*, which is really useful if you upload the project to an open > source Git(Hub) repository. > > It looks like this: > > # ProjectName > > **TODO: Add description** > > ## Installation > > If [available in Hex](https://hex.pm/docs/publish), the package can be > installed as: > > 1. Add `project_name` to your list of dependencies in `mix.exs`: > > ```elixir > def deps do > [{:project_name, "~> 0.1.0"}] > end > ``` > > 2. Ensure `project_name` is started before your application: > > ```elixir > def application do > [applications: [:project_name]] > end > ``` > > > I would like to propose that this autogenerated readme be altered > slightly, to: > > # ProjectName > > **TODO: Add description** > > ## Installation > > If [available in Hex](https://hex.pm/docs/publish), the package can be > installed as: > > 1. Add `project_name` to your list of dependencies in `mix.exs`: > > ```elixir > def deps do > [ > {:project_name, "~> 0.1.0"} > ] > end > ``` > > 2. Ensure `project_name` is started before your application: > > ```elixir > def application do > [applications: [:project_name]] > end > ``` > > > This would make it easier to copy the dependency tuple. > > We might want to also change the generated *mix.exs*, so its dependency > list also starts and ends on separate lines (possibly with a comment > in-between), to make it easier to add dependencies, and gently push > developers to adding new dependencies on separate lines, which would > improve readability: > > defp deps do > [ > # add dependencies here > ] > end > > > Sincerely, > > ~Wiebe-Marten Wijnja > > -- > You received this message because you are subscribed to the Google Groups > "elixir-lang-core" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/elixir-lang-core/c50ae0b2-c476-4dc3-b10b-1fec6771d326%40googlegroups.com > <https://groups.google.com/d/msgid/elixir-lang-core/c50ae0b2-c476-4dc3-b10b-1fec6771d326%40googlegroups.com?utm_medium=email&utm_source=footer> > . > For more options, visit https://groups.google.com/d/optout. > -- You received this message because you are subscribed to the Google Groups "elixir-lang-core" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/elixir-lang-core/CAGnRm4KpAEzmZsW5YVJnzJiOtyERBhj_B%3DdFpaEgs4Y6_cB19g%40mail.gmail.com. For more options, visit https://groups.google.com/d/optout.
