📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 morse-decoder

[morse-decoder] is a program that allows the user to input morse code and convert the message into English words.

🛠 Built With

Tech Stack

Programming language

• Ruby

Key Features

• [Clean code using rubocop linters]
• [Morse decoder functionality]

(back to top)

🚀 Live Demo

Not available.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

To run this project you need to have installed Ruby and a code editor, we are using Visual Studio Code with Code runner extension, this is a video explaining how to configure Code runner.

Setup

Clone this repository to your desired folder: Example commands:

  cd my-folder
  git clone git@github.com:OscarFMdev/morse-decoder.git

Usage

To run the project, add a parameter to decoding-message function, separating each word with 3 spaces and each letter using 1 space and then right-click on the text editor to run with the Code runner extension.

(back to top)

👥 Authors

👤 Author1: Oscar Fernández Muñoz

• GitHub: @OscarFMdev
• Twitter: @OscarFMdev
• LinkedIn: LinkedIn

👤 Lucas Comamala García

• GitHub: @lucascomamala
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [A Graphical User Interface]
• [Inverse decoding]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give this repo a star and reach out on our social media, and we will be happy to know about it! 😃

(back to top)

🙏 Acknowledgments

I would like to thank the Wikipedia Page for showing us how the morse code works.

(back to top)

❓ FAQ

• How can I contribute?

  • Please send us a message on our social media and we will let you contribute.

• What if I have problems running this project?

  • Let us know on our social media DMs, we will be happy to help you.

(back to top)

📝 License

This project is MIT licensed.

(back to top)