1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-06 04:31:29 +00:00

Add a README.md for Github

This commit is contained in:
dmiller
2017-04-21 19:47:50 +00:00
parent 69084bbd38
commit 8f3137bac7

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
Nmap [![Build Status](https://travis-ci.org/nmap/nmap.svg?branch=master)](https://travis-ci.org/nmap/nmap)
====
Nmap is released under a GPL-style license, the full text of which is available
in [the COPYING file](COPYING).
The latest version of this software as well as binary installers for Windows,
macOS, and Linux (RPM) are available from https://nmap.org/
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.