katarighe/morse-code

Morse Code is a Ruby code that decodes morse-coded messages using a few simple steps. It is done as part of our first Ruby projects.

📗 Table of Contents

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

Morse Code

Morse Code is a Ruby code that decodes morse-coded messages using a few simple steps. It is done as part of our first Ruby projects.

🛠 Built With

Tech Stack

Ruby

• Ruby
• Rubocop

Key Features

The key feature of this project includes.

• Decoding the hidden message in Morse Code in 3 different steps.

(back to top)

🚀 Live Demo

• Live Demo of this project is not available at the moment.

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• A code editor (Visual Studio Code is recommended)

• Git and a GitHub account

Setup

Clone this repository to your desired folder by using this 👇️ command :

git clone https://github.com/katarighe/morse-code.git

Install

Go to the project directory:

 cd morse-code

Before to run the program, verify that you have Ruby installed on your OS running the following command:

 ruby -v

It should show you the version of Ruby ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby from scratch.

Download and Install Ruby

Usage

Run the following command inside the project folder:

 ruby morse_code.rb

This will display the following outputs:

 A
 MY NAME
 A BOX FULL OF RUBIES

This is just a test code. If you want to decode other morse code, you must open the morse_code.rb file using the code editor of your choice and change the statement in the decode_message function call at the end of the file:

message = decode_message('add-here-the-morse-code-you-want-to-decode')

Run tests

• Tests are not applicable in this project at the moment.

Deployment

• Deployment is not applicable in this project at the moment.

(back to top)

👥 Authors

👤 Mohamed Aden Ighe

• GitHub: @katarighe
• Twitter: @katarighe
• LinkedIn: @mighe

👤 Noel Nomgne Foka

• GitHub: @noelnomgne
• Twitter: @noelnomgne
• LinkedIn: @noelnomgne

(back to top)

🔭 Future Features

Here are some future features that could be added to the Morse Code in the future.

• Improving the Morse Code Algorithim: This would help us decode the code much better.

These are just a few ideas for future features that could be added to the Morse Code. The specific features that are added will depend on the needs and wants of the users.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

• Project supervised by Microverse
• Creative Commons 4.0 License

(back to top)

📝 License

This project is MIT licensed.

(back to top)