README 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. Apache Ant
  2. What is it?
  3. -----------
  4. Ant is a Java based build tool. In theory it is kind of like "make"
  5. without makes wrinkles and with the full portability of pure java code.
  6. Why?
  7. ----
  8. Why another build tool when there is already make, gnumake, nmake, jam,
  9. and others? Because all of those tools have limitations that its original
  10. author couldn't live with when developing software across multiple platforms.
  11. Make-like tools are inherently shell based. They evaluate a set of
  12. dependencies and then execute commands not unlike what you would issue on a
  13. shell. This means that you can easily extend these tools by using or writing
  14. any program for the OS that you are working on. However, this also means that
  15. you limit yourself to the OS, or at least the OS type such as Unix, that you
  16. are working on.
  17. Makefiles are inherently evil as well. Anybody who has worked on them for any
  18. time has run into the dreaded tab problem. "Is my command not executing
  19. because I have a space in front of my tab!!!" said the original author of Ant
  20. way too many times. Tools like Jam took care of this to a great degree, but
  21. still use yet another format to use and remember.
  22. Ant is different. Instead a model where it is extended with shell based
  23. commands, it is extended using Java classes. Instead of writing shell
  24. commands, the configuration files are XML based calling out a target tree
  25. where various tasks get executed. Each task is run by an object which
  26. implements a particular Task interface.
  27. Granted, this removes some of the expressive power that is inherent by being
  28. able to construct a shell command such as `find . -name foo -exec rm {}` but
  29. it gives you the ability to be cross platform. To work anywhere and
  30. everywhere. And hey, if you really need to execute a shell command, Ant has
  31. an exec rule that allows different commands to be executed based on the OS
  32. that it is executing on.
  33. The Latest Version
  34. ------------------
  35. Details of the latest version can be found on the Apache Ant
  36. Project web site <http://ant.apache.org/>.
  37. Documentation
  38. -------------
  39. Documentation is available in HTML format, in the manual/ directory.
  40. For information about building and installing Ant, see
  41. manual/install.html
  42. The manual for the latest release of Ant is available online at
  43. <https://ant.apache.org/manual/index.html>.
  44. The latest version of the manual is available online at
  45. <https://rawgit.com/apache/ant/master/manual/index.html>.
  46. Licensing
  47. ---------
  48. This software is licensed under the terms you may find in the file
  49. named "LICENSE" in this directory.
  50. This distribution includes cryptographic software. The country in
  51. which you currently reside may have restrictions on the import,
  52. possession, use, and/or re-export to another country, of
  53. encryption software. BEFORE using any encryption software, please
  54. check your country's laws, regulations and policies concerning the
  55. import, possession, or use, and re-export of encryption software, to
  56. see if this is permitted. See <http://www.wassenaar.org/> for more
  57. information.
  58. The U.S. Government Department of Commerce, Bureau of Industry and
  59. Security (BIS), has classified this software as Export Commodity
  60. Control Number (ECCN) 5D002.C.1, which includes information security
  61. software using or performing cryptographic functions with asymmetric
  62. algorithms. The form and manner of this Apache Software Foundation
  63. distribution makes it eligible for export under the License Exception
  64. ENC Technology Software Unrestricted (TSU) exception (see the BIS
  65. Export Administration Regulations, Section 740.13) for both object
  66. code and source code.
  67. The following provides more details on the included cryptographic
  68. software:
  69. For the SSH family of tasks (<sshexec> and <scp>) Ant requires the
  70. JSch <http://www.jcraft.com/jsch/index.html> library as well as the
  71. Java Cryptography extensions
  72. <http://java.sun.com/javase/technologies/security/>. Ant does not
  73. include these libraries itself, but is designed to use them.
  74. Thanks for using Ant.
  75. The Apache Ant Project
  76. <http://ant.apache.org/>