Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Simplify the build instructions.

  • Loading branch information...
commit d9600fe54c5df469a2f440b57c1a81757590c81e 1 parent 858c70b
Ariya Hidayat authored
Showing with 97 additions and 57 deletions.
  1. +91 −0 INSTALL
  2. +6 −57 README.md
View
91 INSTALL
@@ -0,0 +1,91 @@
+HammerJS Build and Installation Instructions
+--------------------------------------------
+
+Tip: If you are on a multicore system (like any modern computer these days),
+you can speed up the build by passing an extra argument to the make command:
+
+ make -j4
+
+where 4 denotes the number of simultaneous compiles.
+
+Mac OS X
+========
+
+Ensure that the development tools are ready to use, i.e. by installing
+Xcode 3.2 or later, see http://developer.apple.com/tools/xcode/.
+
+Run the following:
+
+ ./configure
+ make
+
+To install to /usr/local/bin (requires Administrator password):
+
+ sudo make install
+
+Alternatively copy hammerjs executable to a directory in the PATH, e.g ~/bin.
+
+Tip: For a faster initial build, install CMake 2.6 or later. Go to
+www.cmake.org/cmake/resources/software.html to get the binary package.
+
+If system-wide CMake is available, the configure script will use it.
+Otherwise it will download and build a local CMake.
+
+Linux
+=====
+
+Ensure that the development tools, e.g. compilers and libraries, are ready.
+
+On Kubuntu or Ubuntu, these requirements can be fulfilled by running:
+
+ sudo apt-get install build-essential
+
+On OpenSUSE, these requirements can be fulfilled by running:
+
+ sudo zypper install gcc-g++ make
+
+Run the following:
+
+ ./configure
+ make
+
+Installation step (requires root password):
+
+ sudo make install
+
+Alternatively copy hammerjs executable to a directory in the PATH, e.g ~/bin.
+
+Tip: For a faster initial build, install CMake 2.6 or later.
+If system-wide CMake is available, the configure script will use it.
+Otherwise it will download and build a local CMake.
+
+On Kubuntu or Ubuntu, CMake can be installed using:
+ sudo apt-get install cmake
+
+On OpenSUSE, CMake can be installed using:
+ sudo zypper install cmake
+
+Windows
+=======
+
+Requirement: CMake 2.6 or later.
+See www.cmake.org/cmake/resources/software.html and install the binary MSI.
+
+* Using MinGW (www.mingw.org)
+
+Tested with MinGW GCC version 4.5.
+
+In the command prompt, run the following:
+
+ cmake -G "MinGW Makefiles" .
+ mingw32-make
+
+* Using Visual C++
+
+Tested with Visual Studio/C++ 2010 Express (www.microsoft.com/express/Windows/).
+
+In the command prompt, run the following:
+
+ cmake -G "Visual Studio 10" .
+
+Launch Visual Studio and open the solution file HammerJS.sln. Press F7 to build.
View
63 README.md
@@ -6,69 +6,18 @@ HammerJS has a rich set of API to do file I/O, system access, and syntax parsing
# Build instructions
-**Tip**: If you are on a multicore system (like any modern computer
-these days), you can speed up the build by passing an extra argument to the
-make command, e.g. <code>make -j4</code> (where 4 denotes the number of
-simultaneous compiles at the same time).
+Building HammerJS is as easy as:
-## Mac OS X
-
-Ensure that the development tools are ready to use, i.e. by installing [Xcode 3.2 or later](http://developer.apple.com/tools/xcode/).
-
-Additional requirement is [CMake 2.6 or later](http://www.cmake.org/cmake/resources/software.html) (just install the binary package). This is needed as the build tool.
-
-Run the following:
-
- cmake .
- make
-
-Installation step (requires Administrative password):
-
- sudo make install
-
-## Linux
-
-Ensure that the development tools are ready to use, as well as [CMake 2.6 or later](http://www.cmake.org/cmake/resources/software.html).
-
-On Kubuntu or Ubuntu, these requirements can be fulfilled by running:
-
- sudo apt-get install build-essential cmake
-
-On OpenSUSE, these requirements can be fulfilled by running:
-
- sudo zypper install gcc-g++ make cmake
-
-Run the following:
-
- cmake .
+ ./configure
make
-Installation step (requires root password):
-
- sudo make install
-
-## Windows
-
-Requirement: [CMake 2.6 or later](http://www.cmake.org/cmake/resources/software.html) (install the binary MSI) as the build tool.
-
-### MinGW
-
-Tested with [MinGW](http://www.mingw.org) with GCC version 4.5.
-
-In the command prompt, run the following:
-
- cmake -G "MinGW Makefiles" .
- mingw32-make
-
-### Visual C++
-
-Tested with [Visual Studio/C++ 2010 Express](http://www.microsoft.com/express/Windows/).
+To install the executable (with the target directory <code>/usr/local/bin</code>):
-In the command prompt, run the following:
+ make install
- cmake -G "Visual Studio 10" .
+Alternatively copy <code>hammerjs</code> executable to some directory in the PATH.
-Launch Visual Studio and open the solution file <code>HammerJS.sln</code>. Press F7 to build.
+For more detailed instructions, see the INSTALL file.
# Quick Start
Please sign in to comment.
Something went wrong with that request. Please try again.