From 3346529f92716ca2878c038e42a110ff1a7d772a Mon Sep 17 00:00:00 2001 From: Zloooy Date: Fri, 1 Feb 2019 18:36:23 +0300 Subject: [PATCH] Added README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6797c9b --- /dev/null +++ b/README.md @@ -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