diff --git a/README.md b/README.md index de08a37..4188594 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,72 @@ ## Development +To start development on #Larus, execute the following: + +#. Become some sort of privileged user: + + $ sudo su - + +#. Download the repository configuration: + + # cd /etc/yum.repos.d/ + # wget https://obs.kolabsys.com/repositories/home:/vanmeeuwen:/erlang-18.3/Fedora_23/home:vanmeeuwen:erlang-18.3.repo + # wget https://obs.kolabsys.com/repositories/home:/vanmeeuwen:/phoenix/Fedora_23/home:vanmeeuwen:phoenix.repo + +#. Install elixir: + + # dnf -y install elixir + +#. Don't forget to log out: + + # logout + +#. Provided your GIT checkout, initialize git flow: + + $ git flow init --default + +#. Download and install the required `.ez` files: + + $ mix local.hex + $ mix archive.install https://github.com/phoenixframework/archives/raw/master/phoenix_new.ez + +#. Start a feature, support, hotfix, ...: + + $ git flow feature start trial-and-error + $ cd larus $ mix deps.get $ npm install $ mix phoenix.server +### Before you commit + + $ mix dogma + $ mix credo + +## `~/.vimrc` + +Use `~/.vimrc` or equivalent to ensure the "correct" indentation is used: + +``` +" +" elixir and such +autocmd BufRead,BufNewFile *.ex set shiftwidth=2 tabstop=2 expandtab +autocmd BufRead,BufNewFile *.ex set shiftwidth=2 tabstop=2 expandtab +autocmd BufRead,BufNewFile *.exs set shiftwidth=2 tabstop=2 expandtab +``` + ## l10n Add supported locales to `larus/config/config.exs`. Extract strings: $ mix gettext.extract Merge in new translated strings: + $ mix gettext.merge priv/gettext/ + +Create a new locale: + $ mix gettext.merge priv/gettext/ --locale de