-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Only one version instead of having all in Src - README updated and moved the instructions to its own file - Changed the icon - Added Images - Updated .gitignore - Renamed versions - Moved .exe files to releases
- Loading branch information
Showing
18 changed files
with
122 additions
and
418 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,3 @@ | ||
| Src/1.1.1 | ||
| Src/1.1/__pycache__ | ||
| Src/1.1.2 | ||
| Src/1.2/openscad-2021.01 | ||
| Src/1.2/icono.ico | ||
| Src/1.2/__pycache__ | ||
| Src/openscad-2021.01 | ||
| Src/__pycache__ | ||
| Tests/ |
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| ## >> Instructions | ||
|
|
||
| >Please read before using it to prevent issues when running. | ||
| TO HAVE IN MIND: | ||
|
|
||
| - <b>It's not necessary to download python (or even the files) to use it, there's a .exe file available on [releases](https://github.com/jungby/Braillenius/releases) with the latest features.</b> | ||
|
|
||
| - If you want to use the 3D model generation, it's a must to download OpenScad from this [link](https://openscad.org/downloads.html). | ||
|
|
||
| - To visualize the braille translation using the UI, you need to change your terminal/console's font to one that supports the characters. | ||
|
|
||
| - Python users need to install the following library if you want to use the GUI: | ||
| `pip install PyQt5` | ||
|
|
||
| --- | ||
|
|
||
| ## >> How to | ||
|
|
||
| #### **HOW TO DOWNLOAD THE PROJECT AND USE THE FILES** | ||
|
|
||
| 1. While on [this page](https://github.com/jungby/Braillenius) click the green button "Code" and then "Download ZIP". | ||
|
|
||
| _You can also find the executables on the releases_ | ||
|
|
||
|
|
||
| [](https://postimg.cc/9wjZrVz7) | ||
|
|
||
| _If you are familiar with git, clone it instead._ | ||
|
|
||
|
|
||
| 2. Open the folder you downloaded and extract it. | ||
|
|
||
| What files should I open? | ||
| - For python users, gui (version).py or ui (version).py, Braillenius (version).exe | ||
|
|
||
| #### **HOW TO DOWNLOAD OPENSCAD AND ADD IT TO THE PROJECT** | ||
|
|
||
| 1. Click [OpenScad for 32-bit systems](https://files.openscad.org/OpenSCAD-2021.01-x86-32.zip) or [OpenScad for 64-bit systems](https://files.openscad.org/OpenSCAD-2021.01-x86-64.zip). | ||
| 2. Go to the folder where you saved braillenius, then go to the 1.2 version and save the .zip file there. | ||
| 3. Unzip the file you just downloaded. | ||
|
|
||
| [](https://postimg.cc/PPG1sN82) | ||
|
|
||
| 4. (Optional) Delete the .zip file. | ||
|
|
||
| --- | ||
|
|
||
| #### **HOW TO INSTALL A FONT AND USE IT ON THE TERMINAL** | ||
|
|
||
| >You can skip steps 1,2 and 3 if you want to use your window's default font (MS Gothic) | ||
| 1. Find a font that supports braille characters or download the recommended one here -> [Cascadia Font](https://github.com/microsoft/cascadia-code/releases/download/v2111.01/CascadiaCode-2111.01.zip) | ||
| 2. Extract the files in CascadiaCode-2111.01\ or create a folder where you unzip the file. | ||
| 3. Open the folder where you saved Cascadia Code files, go to tff folder, select every tff file, right click in one of them and click Install. | ||
|
|
||
| [](https://postimg.cc/21SgFYfY) | ||
|
|
||
| 4. Open your terminal/console. | ||
|
|
||
| For Windows Terminal users, press Ctrl + , click Defaults, Appearance, select the font on Font face and Save. | ||
| [](https://postimg.cc/jWdHXByY) | ||
|
|
||
| For Command Prompt users, right click on top of the window, Properties, choose Font tab, select the fond and Ok. | ||
| [](https://postimg.cc/QHsKxX2j) | ||
|
|
||
| 5. Close your terminal/console and open the UI file you want to run. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,112 +1,81 @@ | ||
| # __BRAILLENIUS__ | ||
|
|
||
| This is a braille translator 100% made with Python. Every version is different because I always try to improve and add more features to it. | ||
|
|
||
| This is made to translate from Spanish to Braille, English can be translated but it won't be as precise as Spanish. | ||
|
|
||
| ___Only tested on Windows 10.___ | ||
|
|
||
| ## Table of contents | ||
| * [Instructions](#--instructions) | ||
| * [Download, install and use](#---how-to) | ||
| * [Versions](#11-v) | ||
| * [Future changes](#to-add-change-improve) | ||
| <br /> | ||
| <div align="center"> | ||
|
|
||
| <h1 align="center"><b>BRAILLENIUS</b></h1> | ||
|
|
||
| <p align="center"> | ||
| Spreading awareness with Python and OpenScad. | ||
| <br /> | ||
| <a href="https://github.com/jungby/Braillenius/issues">Report bug or request a feature</a> | ||
| </p> | ||
| <br /> | ||
| </div> | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/jungby/Braillenius/blob/master/INSTRUCTIONS.md")>Getting Started</a> | ||
| </li> | ||
| <li><a href="#future-changes-in-mind">Future changes</a></li> | ||
| <li><a href="#contact-me">Contact</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| --- | ||
| ## About the project | ||
|
|
||
| ## >> Instructions | ||
|
|
||
| >Please read before using it to prevent issues when running. | ||
| TO HAVE IN MIND: | ||
| - If you want to use the 3D model generation it's a must to download OpenScad, portable version recommended. | ||
| - To visualize the braille translation using the UI, you need to change your terminal/console's font to one that supports the characters. | ||
| - Python users need to install the following library if you want to use the GUI: | ||
| `pip install PyQt5` | ||
| - It's not necessary to download python to use it, there's a .exe file available | ||
|
|
||
| [Go back to table of contents](#table-of-contents) | ||
| ## >> How to | ||
|
|
||
| #### **HOW TO DOWNLOAD THE PROJECT AND USE THE FILES** | ||
|
|
||
| 1. While on [this page](https://github.com/jungby/Braillenius) click the green button "Code" and then "Download ZIP". | ||
|
|
||
| _You can also find the executables on this GoogleDrive folder and skip the steps while I learn about github releases:_ _[Google Drive](https://drive.google.com/drive/folders/1GlokmAGRGnUGxVmQ7VoxxLIq1r4Zowyu?usp=sharing)_ | ||
|
|
||
|
|
||
| [](https://postimg.cc/9wjZrVz7) | ||
|
|
||
| _If you are familiar with git clone it instead._ | ||
| <img src="Images/banner.png" alt="Braillenius banner" /> | ||
|
|
||
| The main idea was just to translate, but after a while I decided that I might need to work on a better idea based on this one if I really want to spread awareness about how important accessibility is. | ||
|
|
||
| 2. Open the folder you downloaded and extract it. | ||
| This is a braille translator 100% made with Python. Every version is different because I always try to improve and add more features to it, especially, after the df80bbc commit, I tried to reorganize the way this repo is going so had some big changes after that. | ||
|
|
||
| What files should I open? | ||
| - For python users, gui (version).py or ui (version).py, Braillenius (version).exe | ||
| - For non-python users, Braillenius (version).exe | ||
| Please have in mind that Braillenius is made to translate from Spanish to Braille, English can be translated, but it won't be as precise as Spanish. | ||
|
|
||
| #### **HOW TO DOWNLOAD OPENSCAD AND ADD IT TO THE PROJECT** | ||
|
|
||
| 1. Click [OpenScad for 32-bit systems](https://files.openscad.org/OpenSCAD-2021.01-x86-32.zip) or [OpenScad for 64-bit systems](https://files.openscad.org/OpenSCAD-2021.01-x86-64.zip). | ||
| 2. Go to the folder where you saved braillenius, then go to the 1.2 version and save the .zip file there. | ||
| 3. Unzip the file you just downloaded. | ||
|
|
||
| [](https://postimg.cc/PPG1sN82) | ||
|
|
||
| 4. (Optional) Delete the .zip file. | ||
|
|
||
| #### **HOW TO INSTALL A FONT AND USE IT ON THE TERMINAL** | ||
|
|
||
| >You can skip steps 1,2 and 3 if you want to use your window's default font (MS Gothic) | ||
| 1. Find a font that supports braille characters or download the recommended one here -> [Cascadia Font](https://github.com/microsoft/cascadia-code/releases/download/v2111.01/CascadiaCode-2111.01.zip) | ||
| 2. Extract the files in CascadiaCode-2111.01\ or create a folder where you unzip the file. | ||
| 3. Open the folder where you saved Cascadia Code files, go to tff folder, select every tff file, right click in one of them and click Install. | ||
|
|
||
| [](https://postimg.cc/21SgFYfY) | ||
|
|
||
| 4. Open your terminal/console. | ||
|
|
||
| For Windows Terminal users, press Ctrl + , click Defaults, Appearance, select the font on Font face and Save. | ||
| [](https://postimg.cc/jWdHXByY) | ||
|
|
||
| For Command Prompt users, right click on top of the window, Properties, choose Font tab, select the fond and Ok. | ||
| [](https://postimg.cc/QHsKxX2j) | ||
|
|
||
| 5. Close your terminal/console and open the UI file you want to run. | ||
|
|
||
|
|
||
| [Go back to table of contents](#table-of-contents) | ||
| ___Work in progress and has been only tested on Windows 10.___ | ||
|
|
||
| --- | ||
|
|
||
| ## 1.1 v. | ||
| ## v1.0.0 | ||
|
|
||
| * User friendly interface (gui.py) and command line interface (ui.py) | ||
| * User-friendly interface (gui.py) and command line interface (ui.py) | ||
| * English and Spanish interface (only available on ui.py) | ||
| * Translates from Spanish to Braille and vice-versa | ||
| * Able to save your translation as .txt file | ||
| * Executable file for the GUI so there's no need to install anything | ||
|
|
||
|
|
||
| ## 1.2 v. | ||
| ## v2.0.0 | ||
|
|
||
| 1.1 version features plus: | ||
| Previous features plus: | ||
|
|
||
| * Now supports 3D printing using OpenScad leaving a .stl file ready to be printed | ||
| * Minor changes on the interface but still only available in Spanish | ||
|
|
||
| [Go back to table of contents](#table-of-contents) | ||
| * English added to the UI menu | ||
|
|
||
| --- | ||
|
|
||
| ## Future changes in mind | ||
|
|
||
| * Image recognition | ||
| * Voice input | ||
| * Optimize conversion time (to .stl) | ||
| * Add more languages to translate | ||
| - [ ] Optimize convertion time from .scad to .stl | ||
| - [ ] Add a loading bar | ||
| - [ ] Voice input | ||
| - [ ] Add an option to include the original text to the 3D model before the braille | ||
| - [x] Move executables to releases | ||
| - [ ] Multi-language Support | ||
| - [x] English (only UI) | ||
| - [x] Spanish | ||
| - [ ] Portuguese | ||
| - [ ] French | ||
|
|
||
| [Go back to table of contents](#table-of-contents) | ||
| --- | ||
|
|
||
| >__Contact:__ Discord: laura#5939 | ||
| ## Contact me | ||
| For now, the only social media I am willing to share are: | ||
| * Discord: laura#5939 | ||
| * Twitter: wildhxrmony |
Oops, something went wrong.