Skip to content

Commit 3578e6d

Browse files
docs: update project documentation
1 parent e0cc8b8 commit 3578e6d

1 file changed

Lines changed: 81 additions & 95 deletions

File tree

README.md

Lines changed: 81 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
---
99

10-
> 💝 **Αν αυτό το πρόσθετο σας βοήθησε, παρακαλώ σκεφτείτε να κάνετε μια δωρεά!**
11-
> 💝 **If this plugin helped you, please consider making a donation!**
12-
> 👉 [https://paypal.me/christosbouronikos](https://paypal.me/christosbouronikos)
10+
> **Αν αυτό το πρόσθετο σας βοήθησε, παρακαλώ σκεφτείτε να κάνετε μια δωρεά!**
11+
> **If this plugin helped you, please consider making a donation!**
12+
> [https://paypal.me/christosbouronikos](https://paypal.me/christosbouronikos)
1313
1414
---
1515

16-
## ℹ️ Τι είναι το πλήκτρο NVDA; / What is the NVDA key?
16+
## Τι είναι το πλήκτρο NVDA; / What is the NVDA key?
1717

1818
Το **πλήκτρο NVDA** είναι ένα πλήκτρο τροποποίησης που χρησιμοποιείται για τις εντολές του NVDA.
1919

@@ -29,147 +29,106 @@
2929

3030
---
3131

32-
# 🇬🇷 Ελληνικά
32+
# Ελληνικά
3333

3434
## Επισκόπηση
3535

3636
Ένα πρόσθετο αναγνώστη οθόνης NVDA που βελτιώνει την προσβασιμότητα του λογισμικού ποιοτικής ανάλυσης δεδομένων [Atlas.ti](https://atlasti.com/), καθιστώντας το χρησιμοποιήσιμο για τυφλούς ερευνητές.
3737

38-
## 🎯 Χαρακτηριστικά
38+
## Χαρακτηριστικά
3939

4040
- **Γρήγορη Πλοήγηση Πινάκων** - Μετάβαση μεταξύ Εγγράφων, Κωδικών, Αποσπασμάτων, Σημειώσεων
4141
- **Βοηθοί Ανάγνωσης** - Πληροφορίες για κωδικούς, αποσπάσματα και έγγραφα
4242
- **Βελτιωμένες Ετικέτες** - Ουσιαστικά ονόματα για κουμπιά χωρίς ετικέτα
4343
- **Υποστήριξη Ελληνικών/Αγγλικών**
4444

45-
## ⌨️ Συντομεύσεις Πληκτρολογίου
45+
## Συντομεύσεις Πληκτρολογίου
4646

4747
### Πλοήγηση Πινάκων
48-
| Συντόμευση | Ενέργεια |
49-
|------------|----------|
50-
| `NVDA+Alt+D` | Πίνακας Εγγράφων |
51-
| `NVDA+Alt+C` | Πίνακας Κωδικών |
52-
| `NVDA+Alt+Q` | Πίνακας Αποσπασμάτων |
53-
| `NVDA+Alt+M` | Πίνακας Σημειώσεων |
54-
| `NVDA+Alt+P` | Περιήγηση Έργου |
48+
- **NVDA+Alt+D** - Πίνακας Εγγράφων
49+
- **NVDA+Alt+C** - Πίνακας Κωδικών
50+
- **NVDA+Alt+Q** - Πίνακας Αποσπασμάτων
51+
- **NVDA+Alt+M** - Πίνακας Σημειώσεων
52+
- **NVDA+Alt+P** - Περιήγηση Έργου
5553

5654
### Ανάγνωση
57-
| Συντόμευση | Ενέργεια |
58-
|------------|----------|
59-
| `NVDA+Shift+C` | Λεπτομέρειες κωδικού |
60-
| `NVDA+Shift+Q` | Κείμενο αποσπάσματος |
61-
| `NVDA+Shift+D` | Πληροφορίες εγγράφου |
62-
| `NVDA+Shift+P` | Τρέχων πίνακας |
63-
| `NVDA+Shift+H` | Λίστα συντομεύσεων |
55+
- **NVDA+Shift+C** - Λεπτομέρειες κωδικού
56+
- **NVDA+Shift+Q** - Κείμενο αποσπάσματος
57+
- **NVDA+Shift+D** - Πληροφορίες εγγράφου
58+
- **NVDA+Shift+P** - Τρέχων πίνακας
59+
- **NVDA+Shift+H** - Λίστα συντομεύσεων
6460

65-
## 📦 Εγκατάσταση
61+
## Εγκατάσταση
6662

6763
### Μέθοδος 1: Από Εκδόσεις (Συνιστάται)
68-
1. Κατεβάστε το αρχείο `.nvda-addon` από τις [Εκδόσεις](../../releases)
64+
1. Κατεβάστε το αρχείο `.nvda-addon` από την [σελίδα Εκδόσεων του έργου στο GitHub](../../releases)
6965
2. Κάντε διπλό κλικ στο αρχείο για αυτόματη εγκατάσταση
70-
- **Ή** χρησιμοποιήστε: NVDA Μενού Εργαλεία Κατάστημα Πρόσθετων Εγκατάσταση από εξωτερική πηγή
66+
- **Ή** χρησιμοποιήστε: NVDA Μενού - Εργαλεία - Κατάστημα Πρόσθετων - Εγκατάσταση από εξωτερική πηγή
7167
3. Επανεκκινήστε το NVDA όταν σας ζητηθεί
7268

73-
### Μέθοδος 2: Χτίσιμο από τον Κώδικα
74-
**Για Mac/Linux:**
75-
```bash
76-
./build.sh
77-
```
78-
79-
**Για Windows (PowerShell):**
80-
```powershell
81-
.\build.ps1
82-
```
83-
84-
Μετά το χτίσιμο, το αρχείο `atlastiAccessibility-1.0.0.nvda-addon` θα δημιουργηθεί στον φάκελο του έργου.
85-
86-
### Μέθοδος 3: Από το Κατάστημα NVDA (Σύντομα)
69+
### Μέθοδος 2: Από το Κατάστημα NVDA (Σύντομα)
8770
Το πρόσθετο θα υποβληθεί στο επίσημο κατάστημα πρόσθετων του NVDA σύντομα.
8871

89-
## 🧪 Δοκιμές
72+
## Δοκιμές
9073

9174
Για να δοκιμάσετε το πρόσθετο:
9275
1. Εγκαταστήστε το NVDA στα Windows 10/11
9376
2. Εγκαταστήστε το πρόσθετο
9477
3. Ανοίξτε το Atlas.ti
9578
4. Δοκιμάστε τις συντομεύσεις
9679

97-
## Αντιμετώπιση Προβλημάτων
80+
## Αντιμετώπιση Προβλημάτων
9881

99-
- **Δεν φορτώνει:** `NVDA+N` Εργαλεία Αρχείο Καταγραφής
82+
- **Δεν φορτώνει:** NVDA+N - Εργαλεία - Αρχείο Καταγραφής
10083
- **Συντομεύσεις:** Ελέγξτε ότι το Atlas.ti έχει την εστίαση
10184

102-
## 📄 Άδεια
85+
## Άδεια
10386

10487
GNU GPL v2.0 - Απαιτείται αναφορά στον δημιουργό Christos Bouronikos
10588

10689
---
10790

108-
# 🇬🇧 English
91+
# English
10992

11093
## Overview
11194

11295
A NVDA screen reader add-on that enhances accessibility for [Atlas.ti](https://atlasti.com/) qualitative data analysis software, making it usable for blind researchers.
11396

114-
## 🎯 Features
97+
## Features
11598

11699
- **Quick Panel Navigation** - Jump between Documents, Codes, Quotations, Memos
117100
- **Reading Helpers** - Get information about codes, quotations, and documents
118101
- **Improved Labels** - Meaningful names for unlabeled buttons
119102
- **Greek/English Support**
120103

121-
## ⌨️ Keyboard Shortcuts
104+
## Keyboard Shortcuts
122105

123106
### Panel Navigation
124-
| Shortcut | Action |
125-
|----------|--------|
126-
| `NVDA+Alt+D` | Documents Panel |
127-
| `NVDA+Alt+C` | Codes Panel |
128-
| `NVDA+Alt+Q` | Quotations Panel |
129-
| `NVDA+Alt+M` | Memos Panel |
130-
| `NVDA+Alt+P` | Project Navigator |
107+
- **NVDA+Alt+D** - Documents Panel
108+
- **NVDA+Alt+C** - Codes Panel
109+
- **NVDA+Alt+Q** - Quotations Panel
110+
- **NVDA+Alt+M** - Memos Panel
111+
- **NVDA+Alt+P** - Project Navigator
131112

132113
### Reading
133-
| Shortcut | Action |
134-
|----------|--------|
135-
| `NVDA+Shift+C` | Code details |
136-
| `NVDA+Shift+Q` | Quotation text |
137-
| `NVDA+Shift+D` | Document info |
138-
| `NVDA+Shift+P` | Current panel |
139-
| `NVDA+Shift+H` | List shortcuts |
114+
- **NVDA+Shift+C** - Code details
115+
- **NVDA+Shift+Q** - Quotation text
116+
- **NVDA+Shift+D** - Document info
117+
- **NVDA+Shift+P** - Current panel
118+
- **NVDA+Shift+H** - List shortcuts
140119

141-
## 📦 Installation
120+
## Installation
142121

143122
### Method 1: From Releases (Recommended)
144-
1. Download the `.nvda-addon` file from [Releases](../../releases)
123+
1. Download the `.nvda-addon` file from the [Project Releases page on GitHub](../../releases)
145124
2. Double-click the file to install automatically
146-
- **Or** use: NVDA Menu Tools Add-on Store Install from external source
125+
- **Or** use: NVDA Menu - Tools - Add-on Store - Install from external source
147126
3. Restart NVDA when prompted
148127

149-
### Method 2: Build from Source
150-
**For Mac/Linux:**
151-
```bash
152-
./build.sh
153-
```
154-
155-
**For Windows (PowerShell):**
156-
```powershell
157-
.\build.ps1
158-
```
159-
160-
After building, the `atlastiAccessibility-1.0.0.nvda-addon` file will be created in the project folder.
161-
162-
### Method 3: From NVDA Add-on Store (Coming Soon)
128+
### Method 2: From NVDA Add-on Store (Coming Soon)
163129
This add-on will be submitted to the official NVDA add-on store soon.
164130

165-
**For developers wanting to submit:**
166-
1. Create a GitHub Release with the `.nvda-addon` file
167-
2. Open an issue at [nvaccess/addon-datastore](https://github.com/nvaccess/addon-datastore)
168-
3. Provide the HTTPS download URL, repository URL, and metadata
169-
4. Wait for initial approval (automated security checks)
170-
5. Future updates will be published automatically
171-
172-
## 🧪 Testing Instructions
131+
## Testing Instructions
173132

174133
### Requirements
175134
- Windows 10 or Windows 11
@@ -182,10 +141,10 @@ This add-on will be submitted to the official NVDA add-on store soon.
182141
3. Restart NVDA when prompted
183142
4. Open Atlas.ti
184143
5. Test each shortcut:
185-
- Press `NVDA+Alt+D` - should announce "Documents panel"
186-
- Press `NVDA+Alt+C` - should announce "Codes panel"
187-
- Press `NVDA+Shift+H` - should list all shortcuts
188-
6. Check NVDA log for any errors: `NVDA+N` Tools View Log
144+
- Press NVDA+Alt+D - should announce "Documents panel"
145+
- Press NVDA+Alt+C - should announce "Codes panel"
146+
- Press NVDA+Shift+H - should list all shortcuts
147+
6. Check NVDA log for any errors: NVDA+N - Tools - View Log
189148

190149
### Reporting Issues
191150
If something doesn't work:
@@ -195,22 +154,49 @@ If something doesn't work:
195154
4. Describe what happened vs what you expected
196155
5. Open an issue on GitHub
197156

198-
## Troubleshooting
157+
## Troubleshooting
199158

200-
- **Not loading:** `NVDA+N` Tools View Log
159+
- **Not loading:** NVDA+N - Tools - View Log
201160
- **Shortcuts not working:** Ensure Atlas.ti has focus
202161

203-
## 📄 License
162+
## License
204163

205164
GNU GPL v2.0 - Attribution to original creator Christos Bouronikos required
206165

207166
---
208167

209-
## 🙏 Support the Project
168+
## Support the Project
210169

211170
If you find this addon helpful, please consider:
212-
- ⭐ Starring this repository
213-
- 🐛 Reporting bugs or suggesting features
214-
- � Making a donation: [https://paypal.me/christosbouronikos](https://paypal.me/christosbouronikos)
171+
- Starring this repository
172+
- Reporting bugs or suggesting features
173+
- Making a donation: [https://paypal.me/christosbouronikos](https://paypal.me/christosbouronikos)
174+
175+
---
176+
177+
## For Developers
178+
179+
### Building from Source
180+
181+
**For Mac/Linux:**
182+
```bash
183+
./build.sh
184+
```
185+
186+
**For Windows (PowerShell):**
187+
```powershell
188+
.\build.ps1
189+
```
190+
191+
After building, the `atlastiAccessibility-1.0.0.nvda-addon` file will be created in the project folder.
192+
193+
### Submitting to NVDA Add-on Store
194+
195+
If you want to submit this add-on or contribute to the submission process:
196+
1. Create a GitHub Release with the `.nvda-addon` file
197+
2. Open an issue at [nvaccess/addon-datastore](https://github.com/nvaccess/addon-datastore)
198+
3. Provide the HTTPS download URL, repository URL, and metadata
199+
4. Wait for initial approval (automated security checks)
200+
5. Future updates will be published automatically
215201

216202
Thank you! / Ευχαριστώ!

0 commit comments

Comments
 (0)