Added README.md

This commit is contained in:
Zloooy 2019-02-01 18:36:23 +03:00
parent 6b8b65d127
commit 3346529f92

24
README.md Normal file
View File

@ -0,0 +1,24 @@
PySca - a NEtwork SCAnner rewritten in Python
=============================
What is it?
------------
According to [Wikipedia](https://en.wikipedia.org/wiki/Network_enumeration#Software),
network scanner is a computer program used to retrieve usernames and info on groups, shares, and services of networked computers.
This project is based on ideas of scanner [NESCA](https://github.com/pantyusha/nesca) - it is simple scanner for everyone with GUI. The project is not just another fork of nesca - it is analogue built from scratch using Python language. Another difference from original is modularity of code - PySca has ability to get scan results from wherever you want and put wherever you can with the same user interface.
INSTALLATION
------------
Just run
```bash
git clone http://github.com/ChronosX88/PySca.git
cd PySca
pip install -r requirments.txt
```
RUN
------------
Run
```bash
python main.py
```
in root PySca folder