summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:42:04 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:42:04 +0000
commit0d47952611198ef6b1163f366dc03922d20b1475 (patch)
tree3d840a3b8c0daef0754707bfb9f5e873b6b1ac13 /README.md
parentInitial commit. (diff)
downloadnmap-0d47952611198ef6b1163f366dc03922d20b1475.tar.xz
nmap-0d47952611198ef6b1163f366dc03922d20b1475.zip
Adding upstream version 7.94+git20230807.3be01efb1+dfsg.upstream/7.94+git20230807.3be01efb1+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f7e2b95
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+Nmap [![Build Status](https://travis-ci.org/nmap/nmap.svg?branch=master)](https://travis-ci.org/nmap/nmap) [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/nmap/nmap.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/nmap/nmap/context:cpp) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/nmap/nmap.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/nmap/nmap/context:python) [![Total alerts](https://img.shields.io/lgtm/alerts/g/nmap/nmap.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/nmap/nmap/alerts/)
+====
+
+Nmap is released under a custom license, which is based on (but not compatible
+with) GPLv2. The Nmap license allows free usage by end users, and we also offer
+a commercial license for companies that wish to redistribute Nmap technology
+with their products. See [Nmap Copyright and Licensing](https://nmap.org/book/man-legal.html)
+for full details.
+
+The latest version of this software as well as binary installers for Windows,
+macOS, and Linux (RPM) are available from
+[Nmap.org](https://nmap.org/download.html)
+
+Full documentation is also available
+[on the Nmap.org website](https://nmap.org/docs.html).
+
+Questions and suggestions may be sent to
+[the Nmap-dev mailing list](https://nmap.org/mailman/listinfo/dev).
+
+Installing
+----------
+Ideally, you should be able to just type:
+
+ ./configure
+ make
+ make install
+
+For far more in-depth compilation, installation, and removal notes, read the
+[Nmap Install Guide](https://nmap.org/book/install.html) on Nmap.org.
+
+Using Nmap
+----------
+Nmap has a lot of features, but getting started is as easy as running `nmap
+scanme.nmap.org`. Running `nmap` without any parameters will give a helpful
+list of the most common options, which are discussed in depth in [the man
+page](https://nmap.org/book/man.html). Users who prefer a graphical interface
+can use the included [Zenmap front-end](https://nmap.org/zenmap/).
+
+Contributing
+------------
+Information about filing bug reports and contributing to the Nmap project can
+be found in the [HACKING](HACKING) and [CONTRIBUTING.md](CONTRIBUTING.md)
+files.