Skip to content

Commit 6e019ba

Browse files
docs: update README
1 parent ef9eae4 commit 6e019ba

2 files changed

Lines changed: 54 additions & 1 deletion

File tree

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
1-
# BeepBeepBoop
1+
# Beep Beep Boop -... . . .--. / -... . . .--. / -... --- --- .--.
2+
23
[![.github/workflows/main.yml](https://github.com/KuerbisKuchen02/BeepBeepBoop/actions/workflows/main.yml/badge.svg)](https://github.com/KuerbisKuchen02/BeepBeepBoop/actions/workflows/main.yml)
4+
![GitHub Release](https://img.shields.io/github/v/release/KuerbisKuchen02/BeepBeepBoop)
5+
![GitHub License](https://img.shields.io/github/license/KuerbisKuchen02/BeepBeepBoop)
6+
7+
![Expo](https://img.shields.io/badge/expo-1C1E24?style=for-the-badge&logo=expo&logoColor=#D04A37)
8+
![React Native](https://img.shields.io/badge/react_native-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
9+
![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
10+
11+
## 🧭 Overview
12+
<p align="center">
13+
<img src="https://raw.githubusercontent.com/KuerbisKuchen02/BeepBeepBoop/ef9eae42fd64b8e4efc56da70a110b847f764f50/assets/home_icon.png" width="128" style="margin-right: 20px; float: left;">
14+
</p>
15+
<p align="center">
16+
The Morse Code App allows users to talk to other people in a chat-like environment. Write text and play it as morsecode. Record morsecode and convert it to text. You can also practice translation some preconfigured words.
17+
</p>
18+
19+
20+
## 🚀 Features
21+
✅ Send and retrieve messages via audio in text and morse format
22+
✅ Customise your callsign to identify yourself in your messages
23+
✅ Learn to read and write morse with our built-in learnpage
24+
✅ Replay old messages
25+
🔜 Save your contacts with their callsigns
26+
🔜 Share your callsign via QR-Code
27+
🔜 Encrypt Messages for maximal security
28+
🔜 Change the morsecode sounds to Trump noises (Bing Bong)
29+
30+
## ⚙️ Installation
31+
> [!IMPORTANT]
32+
> Please make sure you have node and npm installed to start building the application.
33+
34+
### Process
35+
First, install all necessary packages:
36+
```bash
37+
npm install
38+
```
39+
Then, you need to eject out of the managed workflow by typing:
40+
```bash
41+
npx expo prebuild
42+
```
43+
44+
If you have an Android VM present on you machine, you are able to run it with:
45+
```bash
46+
npx expo run:android
47+
```
48+
49+
For an iOS VM run it with
50+
```bash
51+
npx expo run:ios
52+
```
53+
54+
## Image Documentation
55+
[Documentation](/doc/image_documentation.pdf)

doc/image_documentation.pdf

1010 KB
Binary file not shown.

0 commit comments

Comments
 (0)