README.md
16d15504
 # ClamAV
 
 ClamAV® is an open source antivirus engine for detecting trojans, viruses,
c68f996e
 malware & other malicious threats.
16d15504
 
 ## Documentation & FAQ
 
c68f996e
 Official documentation can be found online at
 [ClamAV.net](https://www.clamav.net/documents).
 Our source code release tarballs also includes a copy of the documentation for
 [offline](docs/html/UserManual.html) reading.
16d15504
 
 ## ClamAV Signatures
 
f1038add
 Anyone can learn to read and write ClamAV signatures. Take a look
c68f996e
 at the
 [signature writing documentation](https://www.clamav.net/documents/creating-signatures-for-clamav)
 and
 [phishing signature writing documentation](https://www.clamav.net/documents/phishsigs)
 to get started!
16d15504
 
 ## Installation Instructions
 
f1038add
 ### UNIX
16d15504
 
f1038add
 #### Build from Source on Linux/Unix/Mac
16d15504
 
f1038add
 For basic compile and install instructions on Linux/Unix platforms, check out
 the [install instructions](INSTALL.md).
16d15504
 
f1038add
 For detailed instructions specific to building ClamAV please investigate
c68f996e
 our the
 [Linux/Unix/Mac Install instructions in the User Manual](https://www.clamav.net/documents/installing-clamav-on-unix-linux-macos-from-source).
f1038add
 
 #### Install from a binary package
 
 For binary package distribution installation instructions, head over to
964a1e73
 [our website](https://www.clamav.net/documents/installing-clamav).
16d15504
 
f1038add
 ### Windows
 
 #### Build from Source on Windows
 
 The instructions for building ClamAV from source on Windows is located in the
 [Win32 README](win32/README.md).
 
 #### Using an Install Package
 
 We provide an installer to install ClamAV on Windows to "C:\\Program Files".
 This install method will require you to have Adminstrator priveleges.
 
 We also provide a "Portable Install Package" (i.e. a zip of the required files)
 for users that may wish to run ClamAV without installing it to a system-owned
 directory.
 
 For details on how to use either option, head over to the
c68f996e
 [Windows Install instructions in the User Manual](https://www.clamav.net/documents/installing-clamav-on-windows).
f1038add
 
16d15504
 ### Upgrading from a previous version
 
964a1e73
 Some tips on [how to upgrade](https://www.clamav.net/documents/upgrading-clamav)
16d15504
  from a previous version of ClamAV.
 
 ## ClamAV News
 
c68f996e
 For information about the features in this and prior releases, read
 [the news](NEWS.md).
16d15504
 
 Catch up on the latest about ClamAV by reading our
c68f996e
 [blog](http://blog.clamav.net) and follow us on Twitter @clamav.
16d15504
 
 ## Join the ClamAV Community
 
 The best way to get in touch with the ClamAV community is to join our
c68f996e
 [our mailing lists](https://www.clamav.net/documents/mailing-lists-faq), and
 tune to #clamav on [IRC](irc.freenode.net).
16d15504
 
41d36650
 ## Want to make a contribution?
16d15504
 
 The ClamAV development team welcomes
c68f996e
 [code contributions](https://github.com/Cisco-Talos/clamav-devel),
 improvements to [our documentation](https://github.com/Cisco-Talos/clamav-faq), and also
 [bug reports](https://bugzilla.clamav.net/). Thanks for joining us!
6289eda8
 
 ## Credits
 
964a1e73
 [The ClamAV Team](https://www.clamav.net/about.html#credits)