diff --git a/README b/README.md similarity index 64% rename from README rename to README.md index b594c9ec..4c512385 100644 --- a/README +++ b/README.md @@ -1,5 +1,6 @@ This is the source code of Angry IP Scanner, licensed with GPL v2. -http://angryip.org/ + +[AngryIP.org](http://angryip.org/) The code is written mostly in Java. IntelliJ IDEA is recommended for coding, but Eclipse would do as well. @@ -10,18 +11,20 @@ Building JDK 1.6+ as well as Ant are required for building. Using these tools you can build on any platform. The binaries are in the form of -.jar files and can be run with `java -jar '. Deb and rpm packages can +`.jar` files and can be run with `java -jar `. Deb and rpm packages can only be built on Linux. Building of Windows exe can be done on Linux as well. On Ubuntu install the following packages: +``` sudo apt-get install openjdk-7-jdk ant rpm +``` Install JDK and Ant on other platforms as you usually do it. Then use Ant for building a package for your desired platform: -just type `ant' or `make' in the project dir for the list of available targets. +just type `ant` or `make` in the project dir for the list of available targets. -`ant current' would build the app for your current OS. +`ant current` would build the app for your current OS. -The resulting binaries will be put into the `dist' directory. -Run jar files with `java -jar '. +The resulting binaries will be put into the `dist` directory. +Run jar files with `java -jar `. diff --git a/TODO b/TODO.md similarity index 100% rename from TODO rename to TODO.md