Skip to content

Commit 50624c9

Browse files
Radio125Radio125
authored
README.md
1 parent 2a39515 commit 50624c9

File tree

1 file changed

+154
-113
lines changed

1 file changed

+154
-113
lines changed

‎README.md

+154-113
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# SCORM (iSpring Learn) Test Decoder Telegram Bot
22

3-
![Build Status](https://img.shields.io/github/actions/workflow/status/Radio125/SCORM-Test-Decoder-Telegram-Bot/main.yml?branch=main)
3+
![Build Status](https://img.shields.io/github/actions/workflow/status/Radio125/SCORM-Test-Decoder-Telegram-Bot/ci.yml?branch=main)
44
![License](https://img.shields.io/github/license/Radio125/SCORM-Test-Decoder-Telegram-Bot)
55

66
## Table of Contents
@@ -14,132 +14,173 @@
1414
- [Author](#author)
1515
- [License](#license)
1616

17-
<details id="description">
18-
<summary>### Description</summary>
19-
The **SCORM Test Decoder Telegram Bot** is designed to facilitate the extraction and decoding of SCORM (Sharable Content Object Reference Model) test questions and answers from JSON files. It supports SCORM versions 1.2 and 2004, making it a versatile tool for analyzing test data.
17+
## Description
18+
<details>
19+
<summary>Click to expand</summary>
20+
<p>The <strong>SCORM Test Decoder Telegram Bot</strong> is designed to facilitate the extraction and decoding of SCORM (Sharable Content Object Reference Model) test questions and answers from JSON files. It supports SCORM versions 1.2 and 2004, making it a versatile tool for analyzing test data.</p>
2021
</details>
2122

22-
<details id="features">
23-
<summary>### Features</summary>
24-
- **Upload and Decode SCORM Files**: Users can upload `data-1.json` files containing encrypted SCORM test questions. The bot decrypts the data and provides a readable output.
25-
- **SCORM Test Parsing**: The bot automatically identifies the type of each question and provides the correct answers.
26-
- **Real-Time Responses**: Provides immediate feedback by decoding and displaying test content upon file upload.
27-
- **Comprehensive Overview**: Displays all test questions and answers in a single window for quick review.
23+
## Features
24+
<details>
25+
<summary>Click to expand</summary>
26+
<ul>
27+
<li><strong>Upload and Decode SCORM Files</strong>: Users can upload <code>data-1.json</code> files containing encrypted SCORM test questions. The bot decrypts the data and provides a readable output.</li>
28+
<li><strong>SCORM Test Parsing</strong>: The bot automatically identifies the type of each question and provides the correct answers.</li>
29+
<li><strong>Real-Time Responses</strong>: Provides immediate feedback by decoding and displaying test content upon file upload.</li>
30+
<li><strong>Comprehensive Overview</strong>: Displays all test questions and answers in a single window for quick review.</li>
31+
</ul>
2832
</details>
2933

30-
<details id="how-to-use">
31-
<summary>### How to Use</summary>
32-
1. **Start the Bot**: Add the bot to your Telegram contacts and start a chat.
33-
2. **Upload SCORM JSON File**: Send the `data-1.json` file containing SCORM test data to the bot.
34-
3. **Receive Decoded Content**: The bot processes the file and returns the decoded questions and answers in a readable format.
34+
## How to Use
35+
<details>
36+
<summary>Click to expand</summary>
37+
<ol>
38+
<li><strong>Start the Bot</strong>: Add the bot to your Telegram contacts and start a chat.</li>
39+
<li><strong>Upload SCORM JSON File</strong>: Send the <code>data-1.json</code> file containing SCORM test data to the bot.</li>
40+
<li><strong>Receive Decoded Content</strong>: The bot processes the file and returns the decoded questions and answers in a readable format.</li>
41+
</ol>
3542
</details>
3643

37-
<details id="example-result">
38-
<summary>### Example Result</summary>
39-
**Question**: Now match the pairs as they should be:
40-
- **Type**: Matching
41-
- **Answers**:
42-
- 🔗 Pair 1 part 1 -> Pair 1 part 2
43-
- 🔗 Pair 2 part 1 -> Pair 2 part 2
44-
- 🔗 Pair 3 part 1 -> Pair 3 part 2
45-
**Question**: How many blue hairs does Harry Potter have?
46-
- **Type**: Multiple Choice
47-
- **Answers**:
48-
- ❌ A hundred million
49-
- ❌ None
50-
- ✅ Twenty-five
51-
- ❌ Fifty-four
52-
**Question**: Enter the answer to your question from me, how much does a kilo of raisins cost in raisins?
53-
- **Type**: Text Input
54-
**Question**: What is the sequence of notes?
55-
- **Type**: Sequencing
56-
- **Answers**:
57-
1️⃣ Do
58-
2️⃣ Re
59-
3️⃣ Mi
60-
4️⃣ Fa
61-
5️⃣ So
62-
6️⃣ La
63-
7️⃣ Ti
64-
**Question**: There are 2 correct answers, try to guess which options are correct:
65-
- **Type**: Multiple Response
66-
- **Answers**:
67-
- ✅ Second option
68-
- ✅ Option one
69-
- ❌ This is the third option
70-
- ❌ And here is the fourth option
44+
## Example Result
45+
<details>
46+
<summary>Click to expand</summary>
47+
<p><strong>Question</strong>: Match the pairs as they should be:</p>
48+
<ul>
49+
<li><strong>Type</strong>: Matching</li>
50+
<li><strong>Answers</strong>:
51+
<ul>
52+
<li>🔗 Pair 1 part 1 -> Pair 1 part 2</li>
53+
<li>🔗 Pair 2 part 1 -> Pair 2 part 2</li>
54+
<li>🔗 Pair 3 part 1 -> Pair 3 part 2</li>
55+
</ul>
56+
</li>
57+
</ul>
58+
<p><strong>Question</strong>: How many blue hairs does Harry Potter have?</p>
59+
<ul>
60+
<li><strong>Type</strong>: Multiple Choice</li>
61+
<li><strong>Answers</strong>:
62+
<ul>
63+
<li>❌ A hundred million</li>
64+
<li>❌ None</li>
65+
<li>✅ Twenty-five</li>
66+
<li>❌ Fifty-four</li>
67+
</ul>
68+
</li>
69+
</ul>
70+
<p><strong>Question</strong>: Enter the answer to your question from me, how much does a kilo of raisins cost in raisins?</p>
71+
<ul>
72+
<li><strong>Type</strong>: Text Input</li>
73+
</ul>
74+
<p><strong>Question</strong>: What is the sequence of notes?</p>
75+
<ul>
76+
<li><strong>Type</strong>: Sequencing</li>
77+
<li><strong>Answers</strong>:
78+
<ul>
79+
<li>1️⃣ Do</li>
80+
<li>2️⃣ Re</li>
81+
<li>3️⃣ Mi</li>
82+
<li>4️⃣ Fa</li>
83+
<li>5️⃣ So</li>
84+
<li>6️⃣ La</li>
85+
<li>7️⃣ Ti</li>
86+
</ul>
87+
</li>
88+
</ul>
89+
<p><strong>Question</strong>: There are 2 correct answers, try to guess which options are correct:</p>
90+
<ul>
91+
<li><strong>Type</strong>: Multiple Response</li>
92+
<li><strong>Answers</strong>:
93+
<ul>
94+
<li>✅ Second option</li>
95+
<li>✅ Option one</li>
96+
<li>❌ This is the third option</li>
97+
<li>❌ And here is the fourth option</li>
98+
</ul>
99+
</li>
100+
</ul>
71101
</details>
72102

73-
<details id="installation">
74-
<summary>### Installation</summary>
75-
To set up the bot locally:
76-
1. **Clone the Repository**:
77-
<details>
78-
<summary>Click to copy</summary>
79-
```bash
80-
git clone https://github.com/Radio125/SCORM-Test-Decoder-Telegram-Bot.git
81-
```
82-
</details>
83-
2. **Navigate to the Directory**:
84-
<details>
85-
<summary>Click to copy</summary>
86-
```bash
87-
cd SCORM-Test-Decoder-Telegram-Bot
88-
```
89-
</details>
90-
3. **Create a Virtual Environment (optional but recommended)**:
91-
<details>
92-
<summary>Click to copy</summary>
93-
```bash
94-
python -m venv venv
95-
```
96-
</details>
97-
4. **Activate the Virtual Environment**:
98-
<details>
99-
<summary>Click to copy for Windows</summary>
100-
```bash
101-
venv\Scripts\activate
102-
```
103-
</details>
104-
<details>
105-
<summary>Click to copy for macOS/Linux</summary>
106-
```bash
107-
source venv/bin/activate
108-
```
109-
</details>
110-
5. **Install Dependencies**:
111-
<details>
112-
<summary>Click to copy</summary>
113-
```bash
114-
pip install aiogram==3.7.0
115-
```
116-
</details>
117-
6. **Run the Bot**:
118-
<details>
119-
<summary>Click to copy</summary>
120-
```bash
121-
python bot.py
122-
```
123-
</details>
103+
## Installation
104+
<details>
105+
<summary>Click to expand</summary>
106+
<ol>
107+
<li><strong>Clone the Repository</strong>:
108+
<br>
109+
<a href="#" onclick="navigator.clipboard.writeText('git clone https://github.com/Radio125/SCORM-Test-Decoder-Telegram-Bot.git')">
110+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
111+
</a>
112+
<pre>git clone https://github.com/Radio125/SCORM-Test-Decoder-Telegram-Bot.git</pre>
113+
</li>
114+
<li><strong>Navigate to the Directory</strong>:
115+
<br>
116+
<a href="#" onclick="navigator.clipboard.writeText('cd SCORM-Test-Decoder-Telegram-Bot')">
117+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
118+
</a>
119+
<pre>cd SCORM-Test-Decoder-Telegram-Bot</pre>
120+
</li>
121+
<li><strong>Create a Virtual Environment (optional but recommended)</strong>:
122+
<br>
123+
<a href="#" onclick="navigator.clipboard.writeText('python -m venv venv')">
124+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
125+
</a>
126+
<pre>python -m venv venv</pre>
127+
</li>
128+
<li><strong>Activate the Virtual Environment</strong>:
129+
<ul>
130+
<li><strong>Windows</strong>:
131+
<br>
132+
<a href="#" onclick="navigator.clipboard.writeText('venv\\Scripts\\activate')">
133+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
134+
</a>
135+
<pre>venv\Scripts\activate</pre>
136+
</li>
137+
<li><strong>macOS/Linux</strong>:
138+
<br>
139+
<a href="#" onclick="navigator.clipboard.writeText('source venv/bin/activate')">
140+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
141+
</a>
142+
<pre>source venv/bin/activate</pre>
143+
</li>
144+
</ul>
145+
</li>
146+
<li><strong>Install Dependencies</strong>:
147+
<br>
148+
<a href="#" onclick="navigator.clipboard.writeText('pip install -r requirements.txt')">
149+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
150+
</a>
151+
<pre>pip install -r requirements.txt</pre>
152+
</li>
153+
<li><strong>Run the Bot</strong>:
154+
<br>
155+
<a href="#" onclick="navigator.clipboard.writeText('python bot.py')">
156+
<img alt="Copy to clipboard" src="https://img.shields.io/badge/copy%20command-1a73e8?logo=clipboard&style=flat-square">
157+
</a>
158+
<pre>python bot.py</pre>
159+
</li>
160+
</ol>
124161
</details>
125162

126-
<details id="configuration">
127-
<summary>### Configuration</summary>
128-
**Bot Token**: Replace the placeholder token in the `config.py` file with your actual Telegram Bot API token.
129-
**SCORM Files**: Ensure SCORM JSON files are properly formatted for the bot to decode and process them effectively.
163+
## Configuration
164+
<details>
165+
<summary>Click to expand</summary>
166+
<p><strong>Bot Token</strong>: Replace the placeholder token in the <code>config.py</code> file with your actual Telegram Bot API token.</p>
167+
<p><strong>SCORM Files</strong>: Ensure SCORM JSON files are properly formatted for the bot to decode and process them effectively.</p>
130168
</details>
131169

132-
<details id="contributing">
133-
<summary>### Contributing</summary>
134-
If you would like to contribute to the development of this bot, please feel free to fork the repository and submit pull requests. Any suggestions or bug reports are also welcome via GitHub issues.
170+
## Contributing
171+
<details>
172+
<summary>Click to expand</summary>
173+
<p>If you would like to contribute to the development of this bot, please feel free to fork the repository and submit pull requests. Any suggestions or bug reports are also welcome via GitHub issues.</p>
135174
</details>
136175

137-
<details id="author">
138-
<summary>### Author</summary>
139-
Created by Radio125. Feel free to download, distribute, and modify the code. A simple like is enough!
176+
## Author
177+
<details>
178+
<summary>Click to expand</summary>
179+
<p>Created by Radio125. Feel free to download, distribute, and modify the code. A simple like is enough!</p>
140180
</details>
141181

142-
<details id="license">
143-
<summary>### License</summary>
144-
This project is licensed under the MIT License - see the LICENSE file for details.
182+
## License
183+
<details>
184+
<summary>Click to expand</summary>
185+
<p>This project is licensed under the MIT License - see the LICENSE file for details.</p>
145186
</details>

0 commit comments

Comments
 (0)