Initial commit

Nothing's working yet, only some supporting code has been put in place.

1 files changed, 36 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..4186f3f
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+ponymap
+=======
+
+`ponymap' is an experimental network scanner, not even in the alpha stage yet.
+
+The ultimate purpose of this scanner is bruteforcing hosts and ports in search
+of running services.  Replacing nmap is not the goal.
+
+Building and Running
+--------------------
+Build dependencies: openssl, clang, pkg-config, GNU make, awk, sh
+
+If you don't have Clang, you can edit the Makefile to use GCC or TCC, they work
+just as good.  But there's no CMake support yet, so I force it in the Makefile.
+
+ $ git clone https://github.com/pjanouch/ponymap.git
+ $ make
+
+That is all, no installation is required, or supported for that matter.
+
+First you might want to generate a configuration file:
+ $ ./ponymap --write-default-config
+
+After making any necessary edits to the file (there are comments to aid you in
+doing that), simply run the appropriate program with no arguments to retrieve
+a usage text.
+
+License
+-------
+`ponymap' is written by Přemysl Janouch <p.janouch@gmail.com>.
+
+You may use the software under the terms of the ISC license, the text of which
+is included within the package, or, at your option, you may relicense the work
+under the MIT or the Modified BSD License, as listed at the following site:
+
+http://www.gnu.org/licenses/license-list.html