aseprite/INSTALL.md

109 lines
3.6 KiB
Markdown
Raw Normal View History

# Platforms
2012-07-08 04:41:14 +00:00
You should be able to compile Aseprite successfully on the following
2012-07-08 04:41:14 +00:00
platforms:
* Windows + VS2013 + DirectX SDK
2014-08-14 03:41:30 +00:00
* Mac OS X 10.8 Mountain Lion + Xcode 5.1.1 + Mac OS X 10.4 SDK universal
* Linux + gcc with some C++11 support, this port is not compiled
regularly so you can expect some errors in the master branch.
2012-07-08 04:41:14 +00:00
# Get the source code
At the moment the only way to compile Aseprite is clonning the Git
repository located here:
https://github.com/aseprite/aseprite
You can clone it using the following command (read-only URL):
git clone --recursive https://github.com/aseprite/aseprite.git
On Windows you can use programs like
[msysgit](http://msysgit.github.io/) to clone the repository.
# Compiling
2012-07-08 04:41:14 +00:00
2014-08-14 03:41:30 +00:00
Aseprite uses the latest version of [CMake](http://www.cmake.org/)
(3.0) as its build system. You will not need any extra library
because the repository already contains the source code of all
dependencies, even a modified version of the Allegro library is
included in master branch.
2013-11-23 19:32:13 +00:00
The following are the steps to compile Aseprite (in this case we have
the repository clone in a directory called `aseprite-source`):
2012-07-08 04:41:14 +00:00
1. Make a build directory to leave all the files that are result of
the compilation process (`.exe`, `.lib`, `.obj`, `.a`, `.o`, etc).
C:\...\>cd aseprite-source
C:\...\aseprite-source>mkdir build
2012-07-08 04:41:14 +00:00
In this way, if you want to start with a fresh copy of Aseprite
2012-07-08 04:41:14 +00:00
source code, you can remove the `build` directory and start again.
2. Enter in the new directory and execute cmake giving to it
your compiler as generator:
C:\...\aseprite-source>cd build
2012-07-08 04:41:14 +00:00
If you have nmake (MSVC compilers):
C:\...\aseprite-source\build>cmake .. -G "NMake Makefiles"
2012-07-08 04:41:14 +00:00
If you have Visual Studio you can generate a solution:
C:\...\aseprite-source\build>cmake .. -G "Visual Studio 12 2013"
2012-07-08 04:41:14 +00:00
If you are on Linux:
/.../aseprite-source/build$ cmake .. -G "Unix Makefiles"
2012-07-08 04:41:14 +00:00
For more information in [CMake wiki](http://www.vtk.org/Wiki/CMake_Generator_Specific_Information).
2012-07-08 04:41:14 +00:00
3. After you have executed one of the `cmake .. -G <generator>`
commands, you have to compile the project executing make, nmake,
opening the solution, etc.
4. When the project is compiled, you can find the executable file
inside `build/bin/aseprite.exe`.
2014-08-14 03:41:30 +00:00
## Mac OS X details
You need the old Mac OS X 10.4 SDK universal, which can be obtained
from Xcode 3.1 Developer Tools (Xcode 3.1 Developer DVD,
`xcode31_2199_developerdvd.dmg`). You can get it from Apple developer
2014-08-14 03:41:30 +00:00
website (you need to be registered):
https://developer.apple.com/downloads/
Inside the `Packages` folder, there is a `MacOSX10.4.Universal.pkg`,
install it (it will be installed in `/SDKs/MacOSX10.4u.sdk`), and run
cmake with the following parameters:
2014-08-14 03:41:30 +00:00
-DCMAKE_OSX_ARCHITECTURES:STRING=i386
2014-08-14 03:41:30 +00:00
-DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=10.4
-DCMAKE_OSX_SYSROOT:STRING=/SDKs/MacOSX10.4u.sdk
### Issues with Retina displays
If you have a Retina display, check this issue:
https://github.com/aseprite/aseprite/issues/589
# Using shared third party libraries
2013-11-23 19:32:13 +00:00
If you don't want to use the embedded code of third party libraries
(i.e. to use your installed versions), you can disable static linking
configuring each `USE_SHARED_` option.
After running `cmake -G`, you can edit `build/CMakeCache.txt` file, and
2013-11-23 19:32:13 +00:00
enable the `USE_SHARED_` flag (set its value to `ON`) of the library
that you want to be linked dynamically.
# Profiling
You must compile with `Profile` configuration. For example on Linux:
/.../aseprite-source/build$ cmake .. -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING=Profile -DCOMPILER_GCC:BOOL=ON