Skip to content

Commit bfd20fe

Browse files
committed
Doc and instal-def updates
1 parent 0aeef04 commit bfd20fe

File tree

3 files changed

+27
-11
lines changed

3 files changed

+27
-11
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ The program is written in the language Nim.
1919

2020
#### Installation on linux
2121
- download latest linux-release (tar.gz).
22-
- unpack, place it somewhere in your user-folder, and run the executable "flashread".
22+
- unpack, place it somewhere in your user-folder.
23+
- open a terminal and go to your Readibl-directory.
24+
- run the executable "flashread" by entering: ./flashread
2325
- to access the local web-server you just started, type:
2426
http://localhost:5050/flashread-form
2527
- the portnumber can now be changed in the configuration-file: settings_flashread.conf
28+
- see also in the readibl-folder: help_info/help.txt
2629

27-
If the paths you see on the webpage dont match the location of the application, adjust and run the linux-script flashread_sh. If the app is started from the dir where the application resides, path-problems can be avoided.
30+
If the app is started from a dir where the application does NOT reside, path-problems will occur. In that case adjust and run the linux-script flashread_sh.
2831

2932

3033
#### Installation on windows

mostfiles/help.txt

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,35 @@ Readibl Text Reformatter is a program to format normal text or html, so that it
33
Web-links:
44
https://github.com/some-avail/readibl
55
https://github.com/some-avail/readibl/wiki
6+
----------------------------------------------------------------------
67

8+
INSTALLATION ON LINUX
79

8-
Installation on linux:
9-
-download latest linux-release (tar.gz).
10-
-unpack, place it somewhere in your user-folder, and run the executable "flashread".
11-
-to access the local web-server you just started, type: http://localhost:5050/flashread-form
12-
-the portnumber can be changed in the configuration-file: settings_flashread.conf
10+
Download latest linux-release (tar.gz).
11+
12+
Just unpack, place it somewhere in your user-folder.
13+
I prefer to start the app from a terminal, so that the programs status-info can be viewed.
14+
So to run the executable "flashread" firstly open a terminal, then go to the readibl-folder and enter:
15+
./flashread
16+
17+
To access the web-server you just started, click on or type in your browser: http://localhost:5050/flashread-form
18+
19+
If the app is started from a folder where the application does NOT reside (like so: path/to/readibl/flashread), path-problems will occur. This may apply when you want to start the app together with the OS-startup. In that case you need to adjust and start up from flashread_sh (like so: path/to/readibl/flashread_sh)
20+
But if you use flashread_sh, then update it with the path of you readibl-dir.
1321

14-
If the paths you see on the webpage dont match the location of the application, adjust and run the linux-script flashread_sh. If the app is started from the dir where the application resides, path-problems can be avoided.
22+
For the changes see mostfiles/what-is-new.txt
1523

24+
The portnumber can be changed in the configuration-file: settings_flashread.conf
25+
26+
-------------------------------------------------------------------
27+
28+
INSTALLATION ON WINDOWS
1629

17-
Installation on windows
1830
-download latest windows-release (.zip)
19-
-unpack, place it somewhere in your user-folder, and run the executable "flashread".
31+
-unpack, place it somewhere in your user-folder, and run the executable "flashread.exe".
2032
-to access the local web-server you just started, type: http://localhost:5050/flashread-form
2133

22-
34+
--------------------------------------------------------------------
2335
Usage
2436
Then you get the user-interface in the browser. From there on you can use the clipboard-contents to either reformat a copied text, or use a copied web-address to process and reformat. Experiment with the switches. In the config-file "settings_flashread.conf" you can do the following:
2537

mostfiles/install_defs/readibl_0.95_for-linux_snelinstaller_2.45.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ arguments---linux_set_exe=1
3737
#target#
3838
.
3939
flashread
40+
flashread_sh
4041
>----------------------------------<
4142
TARGET-LOCATION AND SOURCE-FILES TO COPY
4243
comment: here stuff the starting-dir

0 commit comments

Comments
 (0)