https://github.com/naomiyocum/night_writer
A program that translates English to Braille and Braille back to English.
https://github.com/naomiyocum/night_writer
rspec-rails ruby
Last synced: over 1 year ago
JSON representation
A program that translates English to Braille and Braille back to English.
- Host: GitHub
- URL: https://github.com/naomiyocum/night_writer
- Owner: naomiyocum
- Created: 2022-09-22T20:13:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T03:46:22.000Z (over 3 years ago)
- Last Synced: 2025-02-03T11:50:51.419Z (over 1 year ago)
- Topics: rspec-rails, ruby
- Language: Ruby
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Night Writer
## Table of contents
* [General Info](#general-info)
* [Learning Goals](#learning-goals)
* [Technologies](#technologies)
* [Usage](#usage)
* [English to Braille](#english-to-braille)
* [Braille to English](#braille-to-english)
## General Info
Night Writer was a solo project assigned to us during week 5 of Mod 1 of 4 in Turing's School of Software & Design.
Our challenge was to create a program that translates English to Braille and Braille back to English.
The idea of [Night Writing](https://en.wikipedia.org/wiki/Night_writing) was first developed for Napoleon’s army so soldiers could communicate silently at night without light.
The concept of night writing led to Louis Braille’s development of his [Braille tactile writing system](https://en.wikipedia.org/wiki/Braille).
## Learning Goals
* Practice breaking a program into logical components
* Testing components in isolation and in combination
* Applying Enumerable techniques in a real context
* Reading text from and writing text to files
## Technologies
* Ruby 2.7
* RSpec
* Pry
* SimpleCov
* Git
* Atom
## Usage
In your terminal, run `git clone` with the copied URL onto your local machine and navigate into the `night_writer` directory. Now, we can start doing some translations!
### English to Braille
Open the `message.txt` file and update it with the message you would like to translate to Braille.
Return to your terminal and run the following command:
```
$ ruby ./lib/night_writer.rb message.txt braille.txt
```
You should see a return message similar to `Created 'braille.txt' containing 37 characters` indicating the translation was completed successfully.
You can view the translation in the `braille.txt` file.
### Braille to English
To translate back to English, run this following command in your terminal:
```
$ ruby ./lib/night_reader.rb braille.txt og_message.txt
```
You should see a return message similar to `Created 'og_message.txt' containing 202 characters` indicating the translation back to English was completed successfully.
You can view the translation in the `og_message.txt` file.