Skip to content

Commit 168846b

Browse files
Updated README.md [installation and start documentation changes]
1 parent 89bef3f commit 168846b

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
> You can also contact the developer via e-mail: osint.technologies@gmail.com
2727
2828

29-
## About DPULSE
29+
# About DPULSE
3030

3131
DPULSE is a software solution for conducting OSINT research in relation to a certain domain. Using this software you can extract useful information such as:
3232
1. WHOIS information
@@ -42,37 +42,44 @@ DPULSE is a software solution for conducting OSINT research in relation to a cer
4242
All these results are compiled into an easy-to-read PDF or XLSX report by category.
4343

4444

45-
## How to install DPULSE
46-
45+
# How to install and run DPULSE
4746

4847
> **Attention every DPULSE user! You DON'T NEED TO INSTALL WKHTMLTOPDF ANYWHERE if you cloned repository with last updates from June 18, 2024! Also don't forget to install new requirements! When v1.0.3 will be released, we strongly recommend you to update!**
4948
49+
## _Recommended ways_
50+
51+
Since DPULSE repository is using Poetry to manage dependencies, it is higly recommended to install and start DPULSE using Poetry, especially on Linux systems where a lot of Python packages which DPULSE requires are preinstalled.
52+
53+
### First way (recommended on every OS, using Poetry)
5054

51-
### First way
55+
Use this set of commands to get guaranteed start on Windows and Linux systems:
56+
57+
```
58+
git clone https://github.com/OSINT-TECHNOLOGIES/dpulse
59+
cd dpulse
60+
poetry install
61+
poetry run python dpulse.py
62+
```
63+
### Second way (recommended on Windows systems, without using Poetry)
5264

5365
Simply download zip archive from assets in releases bookmark, just right here:
5466

5567
![изображение](https://github.com/OSINT-TECHNOLOGIES/dpulse/assets/77023667/bd2ebf09-a31c-4e27-a674-5b602808a667)
5668

57-
Then you just unpack the archive, open terminal in DPULSE root folder and use `pip install -r requirements.txt` to install requirements.
69+
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.
5870

59-
### Second way
71+
You also can use this way with some different approach using this set of commands:
6072

61-
Cloning GitHub repository and requirements, you can do it using 3 simple commands:
62-
6373
```
6474
git clone https://github.com/OSINT-TECHNOLOGIES/dpulse
6575
cd dpulse
6676
pip install -r requirements.txt
77+
python dpulse.py
6778
```
6879

69-
### Third way
70-
71-
Install using pip manager using this command: `pip install dpulse`
72-
73-
## DPULSE demos
80+
# DPULSE demos
7481

75-
### You can start DPULSE and see the main menu on the screen using `python dpulse.py` command in DPULSE root folder.
82+
### 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
7683

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

@@ -85,13 +92,13 @@ Install using pip manager using this command: `pip install dpulse`
8592
![изображение](https://github.com/OSINT-TECHNOLOGIES/dpulse/assets/77023667/7de73250-c9b6-4373-b21e-16bbb7a63882)
8693

8794

88-
## Tasks to complete before new release
95+
# Tasks to complete before new release
8996
- [x] Create CSV report processing function
9097
- [ ] Bugfixes
9198
- [x] Find an opportunity to get rid of the manual installation of wkhtmltopdf
9299
- [ ] IntelliSearch function to search useful strings in documents, SMs and so on
93100

94-
## DPULSE mentions in social medias
101+
# DPULSE mentions in social medias
95102

96103
### [DPULSE first mention on X.com](https://x.com/DarkWebInformer/status/1787583156775759915?t=Ak1W9ddUPpDvLAkVyQG8fQ&s=19)
97104

0 commit comments

Comments
 (0)