Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 1.63 KB

README.md

File metadata and controls

52 lines (32 loc) · 1.63 KB

ElixirTerminalWordle

ElixirTerminalWordle allows you to play a version of Wordle where all the words are related to Elixir.

Do you dare to try a game? :)

Example of match

How to play?

QuickStart Installation

  • Step 1: Install Elixir. As a prerequisite for elixir installation, you have to have Erlang installed (> 0.23).

  • Step 2: Download the project.

    • git clone https://github.com/IciaCarroBarallobre/ElixirTerminalWordle
  • Step 3: Go to the project folder and install Mix dependencies.

      1. Go to the project folder:
      • Windows: dir ElixirTerminalWordle
      • Linux: cd ElixirTerminalWordle
      1. Install the dependencies: mix deps.get.

If you have any problem, please let me know in the issues page of the project. The most common issues are solved on #Troubleshooting.

QuickStart

To play on Windows, open a terminal in the project folder and:

> iex.bat -S mix #Windows

iex > WordleTerminalGame.start()

To play on Linux, open a terminal in the project folder and:

> iex -S mix 
iex > WordleTerminalGame.start()

If you have any problem, please let me know in the issues page of the project. The most common issues are solved on #Troubleshooting.

Documentation

You can generate the documentation running mix docs, which uses ExDocs library specified in the dependencies.

This documentation is going to be generated under the /docs folder (with the .html extension).

Troubleshooting

(TO-DO)