An open API service indexing awesome lists of open source software.

https://github.com/oscarfmdev/morse-decoder

This is a morse decoder program built using Ruby
https://github.com/oscarfmdev/morse-decoder

Last synced: 11 months ago
JSON representation

This is a morse decoder program built using Ruby

Awesome Lists containing this project

README

          

# πŸ“— Table of Contents

- [πŸ“– About the Project](#about-project)
- [πŸ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [πŸš€ Live Demo](#live-demo)
- [πŸ’» Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [πŸ‘₯ Authors](#authors)
- [πŸ”­ Future Features](#future-features)
- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [πŸ“ License](#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

### 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](https://www.ruby-lang.org/en/documentation/installation/) and a code editor, we are using [Visual Studio Code](https://code.visualstudio.com/download) with Code runner extension, this is a [video](https://www.youtube.com/watch?v=bDSIzatb1N4) explaining how to configure Code runner.

### Setup

Clone this repository to your desired folder:
Example commands:

```sh
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](https://github.com/OscarFMdev)
- Twitter: [@OscarFMdev](https://twitter.com/OscarFMdev)
- LinkedIn: [LinkedIn](https://linkedin.com/in/OscarFMdev)

πŸ‘€ **Lucas Comamala GarcΓ­a**

- GitHub: [@lucascomamala](https://github.com/lucascomamala)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/lucas-comamala/)

(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](../../issues/).

(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](https://en.wikipedia.org/wiki/Morse_code) 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](./MIT.md) licensed.

(back to top)