-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
69084bb
commit 8f3137b
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |