Skip to content

Commit 890da2b

Browse files
committed
build instruction for windows. Screenshot
1 parent 1d9330e commit 890da2b

File tree

2 files changed

+62
-1
lines changed

2 files changed

+62
-1
lines changed

README.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,65 @@
22

33
Document authoring tool for BrailleRAP allowing to mix svg vector graphics with Braille.
44

5-
!!! Work in Progress !!!
5+
![](./screenshot/screenshot1.jpg)
6+
7+
## Features
8+
9+
* Text to Braille conversion
10+
* SVG import
11+
* Build tangible sketch from svg by printing Braille dots along vector graphic Path
12+
* Add text label anywhere on the page layout
13+
* Scale, rotate and move any element on the page layout
14+
* Display a print preview
15+
* Direct print to BrailleRAP embosser
16+
17+
# Building on Windows
18+
19+
## Prerequisites
20+
21+
* Python 3.6 or later
22+
* NodeJS 20.12 or later
23+
24+
## Creating python virtual environment
25+
26+
```
27+
python -m venv venv
28+
```
29+
30+
## Activating python virtual environment
31+
32+
```
33+
.\venv\Scripts\activate
34+
```
35+
36+
## Installing python dependencies
37+
38+
```
39+
pip install -r requirements.txt
40+
```
41+
42+
## Installing nodejs dependencies
43+
44+
```
45+
npm install
46+
```
47+
48+
## Running in dev environement
49+
50+
```
51+
npm run startview
52+
```
53+
54+
## Building exe
55+
56+
```
57+
npm run buildview
58+
```
59+
check DesktopBrailleRAP.exe in dist folder
60+
61+
62+
# Building on Linux
63+
64+
more to come soon
65+
66+
`

screenshot/screenshot1.jpg

131 KB
Loading

0 commit comments

Comments
 (0)