Skip to content

Commit 078ae05

Browse files
Updated README.md with more instructions about installation
1 parent 6776238 commit 078ae05

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,15 @@ _* Poetry is a tool for dependency management and packaging in Python. It can be
5454

5555
### First way (recommended on every OS, using Poetry)
5656

57-
Use this set of commands to get guaranteed start on Windows and Linux systems:
57+
Use this set of commands to use recommended way of DPULSE installation:
5858

5959
```
6060
git clone https://github.com/OSINT-TECHNOLOGIES/dpulse
6161
cd dpulse
6262
poetry install
63-
poetry run python dpulse.py
6463
```
64+
Then you simply start DPULSE using `poetry run python dpulse.py`
65+
6566
### Second way (recommended on Windows systems, without using Poetry)
6667

6768
Simply download zip archive from assets in releases bookmark, just right here:
@@ -70,18 +71,39 @@ Simply download zip archive from assets in releases bookmark, just right here:
7071

7172
Then you just unpack the archive, open terminal in DPULSE root folder and use `pip install -r requirements.txt` command to install requirements. Then type `python dpulse.py` in terminal, and that's where program starts.
7273

73-
You also can use this way with some different approach using this set of commands:
74+
You also can use this installation way with some different approach using this set of commands:
7475

7576
```
7677
git clone https://github.com/OSINT-TECHNOLOGIES/dpulse
7778
cd dpulse
7879
pip install -r requirements.txt
79-
python dpulse.py
8080
```
8181

82+
## _Installers usage_
83+
84+
DPULSE has two pre-written installation scripts, both for Windows (installer.bat) and for Linux (installer.sh). You can use them to clone repository and install dependencies or only for dependencies installation. Keep in mind that installer.bat (Windows installer) requires installed Git to clone repository.
85+
86+
### Windows installer usage
87+
88+
You can start installer.bat from terminal by typing `./installer.bat` in terminal. Then you choose menu item which you want to start.
89+
90+
If you have problems with starting installer.bat, you should try to start it in admin terminal.
91+
92+
### Linux installer usage
93+
94+
To start installer.sh in Linux you should follow these steps in your terminal:
95+
96+
```
97+
sudo chmod +x installer.sh
98+
sudo bash installer.sh
99+
```
100+
Then you choose menu item which you want to start.
101+
102+
If you have problems with starting installer.bat, you should try to use `dos2unix installer.sh` or `sed -i 's/\r//' installer.sh` commands.
103+
82104
# DPULSE demos
83105

84-
### You can start DPULSE and see the main menu on the screen using `python dpulse.py` command in DPULSE root folder. Don't forget to install all requirements before starting DPULSE
106+
### You can start DPULSE and see the main menu on the screen using one of the recommended commands in DPULSE root folder. Don't forget to install all requirements before starting DPULSE
85107

86108
![dpulse_start](https://github.com/OSINT-TECHNOLOGIES/dpulse/assets/77023667/2ac7f332-5482-45e4-a0c9-0cc20e0e0ac7)
87109

0 commit comments

Comments
 (0)