1# ClamAV 2 3ClamAV® is an open source antivirus engine for detecting trojans, viruses, 4malware & other malicious threats. 5 6## Documentation & FAQ 7 8Official documentation can be found online at 9[ClamAV.net](https://docs.clamav.net/). 10Our source code release tarballs also includes a copy of the documentation for 11[offline](docs/html/UserManual.html) reading. 12 13## ClamAV Signatures 14 15Anyone can learn to read and write ClamAV signatures. To get started, see our 16[signature writing documentation](https://docs.clamav.net/manual/Signatures.html). 17 18## Installation Instructions 19 20### UNIX 21 22#### Build from Source on Linux/Unix/Mac 23 24For basic compile and install instructions on Linux/Unix platforms, check out 25the [install instructions](INSTALL.autotools.md). 26 27For detailed instructions specific to building ClamAV please investigate 28our the 29[Linux/Unix/Mac Install instructions in the User Manual](https://docs.clamav.net/manual/Installing/Installing-from-source-Unix.html). 30 31For instructions on how to build ClamAV using our new *experimental* CMake 32build tooling, see [INSTALL.cmake.md](INSTALL.cmake.md) 33 34#### Install from a binary package 35 36For binary package distribution installation instructions, head over to 37[our website](https://docs.clamav.net/manual/Installing/Packages.html). 38 39### Windows 40 41#### Build from Source on Windows 42 43The instructions for building ClamAV from source on Windows is located in the 44[Win32 README](win32/README.md). 45 46#### Using an Install Package 47 48We provide an installer to install ClamAV on Windows to "C:\\Program Files". 49This install method will require you to have Adminstrator priveleges. 50 51We also provide a "Portable Install Package" (i.e. a zip of the required files) 52for users that may wish to run ClamAV without installing it to a system-owned 53directory. 54 55For details on how to use either option, head over to the 56[Windows Install instructions in the User Manual](https://docs.clamav.net/manual/Installing.html). 57 58For instructions on how to build ClamAV using our new *experimental* CMake 59build tooling, see [INSTALL.cmake.md](INSTALL.cmake.md) 60 61### Upgrading from a previous version 62 63Some tips on [how to upgrade](https://docs.clamav.net/faq/faq-upgrade.html) 64 from a previous version of ClamAV. 65 66## ClamAV News 67 68For information about the features in this and prior releases, read 69[the news](NEWS.md). 70 71Catch up on the latest about ClamAV by reading our 72[blog](http://blog.clamav.net) and follow us on Twitter @clamav. 73 74## Join the ClamAV Community 75 76The best way to get in touch with the ClamAV community is to join our 77[our mailing lists](https://docs.clamav.net/faq/faq-ml.html), and 78tune to #clamav on [IRC](irc.freenode.net). 79 80## Want to make a contribution? 81 82The ClamAV development team welcomes 83[code contributions](https://github.com/Cisco-Talos/clamav-devel), 84improvements to [our documentation](https://github.com/Cisco-Talos/clamav-faq), 85and also [bug reports](https://github.com/Cisco-Talos/clamav/issues). Thanks for joining us! 86 87## Credits 88 89[The ClamAV Team](https://www.clamav.net/about.html#credits) 90