mirror of
https://github.com/aseprite/aseprite.git
synced 2024-10-04 13:59:46 +00:00
Update INSTALL and CONTRIBUTING guides
This commit is contained in:
David Capello
parent
f62356d410
commit
28cfa9790f
@ -19,17 +19,16 @@ The following sections explain some tips about each of these points.
|
||||
## Documentation
|
||||
|
||||
You can start seeing the
|
||||
[Wiki](https://code.google.com/p/aseprite/wiki/Home), and
|
||||
[contact us](http://groups.google.com/group/aseprite-discuss) about your changes,
|
||||
we'll give you editing permissions if they looks fine. Also you can
|
||||
make some comments in the Wiki itself.
|
||||
[documentation](http://www.aseprite.org/docs/), and
|
||||
[contact us](support@aseprite.org) if you want to help
|
||||
writting documentation or recording [tutorials](http://www.aseprite.org/tutorial/).
|
||||
|
||||
If you are going to write a Wiki page about some topic, we recommend
|
||||
you to take screenshots or record a little GIF showing the steps.
|
||||
If you are going to write documentation, we recommend you to take
|
||||
screenshots or record a GIF animations to show steps:
|
||||
|
||||
* As screen recording software, on Windows you can generate GIF files
|
||||
using licecap: http://www.cockos.com/licecap/
|
||||
* You can upload the PNG/GIF files in http://imgur.com/ temporarily.
|
||||
using [LICEcap](http://www.cockos.com/licecap/).
|
||||
* You can upload the PNG/GIF images to [Imgur](http://imgur.com/).
|
||||
|
||||
## Issues
|
||||
|
||||
@ -41,11 +40,12 @@ are encouraged to create mockups for any issue you see and attach them.
|
||||
## Hacking
|
||||
|
||||
The first thing to keep in main if you want to modify the source code:
|
||||
checkout the **dev** branch. It is the branch that we use to develop
|
||||
new features and fix issues that are planned for the next big release.
|
||||
checkout the **master** branch. It is the branch that we use to
|
||||
develop new features and fix issues that are planned for the next big
|
||||
release.
|
||||
|
||||
To start looking the source code, see how it is organized in
|
||||
[src/README.md](https://github.com/aseprite/aseprite/tree/dev/src/#aseprite-source-code)
|
||||
[src/README.md](https://github.com/aseprite/aseprite/tree/master/src/#aseprite-source-code)
|
||||
file.
|
||||
|
||||
## Get the Source Code
|
||||
@ -57,7 +57,7 @@ https://github.com/aseprite/aseprite
|
||||
|
||||
You can clone it locally using the following command (read-only URL):
|
||||
|
||||
git clone -b dev git://github.com/aseprite/aseprite.git
|
||||
git clone git://github.com/aseprite/aseprite.git
|
||||
|
||||
On Windows you can use programs like
|
||||
[msysgit](http://msysgit.github.io/) to clone the repository.
|
||||
@ -73,19 +73,19 @@ You can fork the GitHub repository using the Fork button at
|
||||
|
||||
The Pull Requests (PR) systems works in this way:
|
||||
|
||||
1. You've to create a new branch from `dev`, e.g. `fix-8` to fix the issue 8.
|
||||
1. You've to create a new branch from `master`, e.g. `fix-8` to fix the issue 8.
|
||||
1. Start working on that new branch, and push that branch to your fork.
|
||||
1. Create a new PR to merge your `fix-8` branch to official `dev`.
|
||||
1. If the PR is accepted, your branch is merged into `dev`.
|
||||
1. You will need to pull changes from the official `dev` branch, and
|
||||
merge them in your own `dev` branch. Finally you can discard your
|
||||
1. Create a new PR to merge your `fix-8` branch to official `master`.
|
||||
1. If the PR is accepted, your branch is merged into `master`.
|
||||
1. You will need to pull changes from the official `master` branch, and
|
||||
merge them in your own `master` branch. Finally you can discard your
|
||||
own `fix-8` branch (because those changes should be already merged
|
||||
into `dev` if the PR was accepted).
|
||||
1. Continue working from the new `dev` head.
|
||||
into `master` if the PR was accepted).
|
||||
1. Continue working from the new `master` head.
|
||||
|
||||
To keep in mind: **always** start working from the `dev` head, if you
|
||||
To keep in mind: **always** start working from the `master` head, if you
|
||||
want to fix three different issues, create three different branches
|
||||
from `dev` and then send three different PR. Do not chain all the
|
||||
from `master` and then send three different PR. Do not chain all the
|
||||
fixes in one single branch. E.g. `fix-issues-3-and-8-and-25`.
|
||||
|
||||
## Mailing List
|
||||
@ -99,4 +99,4 @@ to avoid programming in something that is already done or which
|
||||
someone else is working on.
|
||||
|
||||
And always remember to look the
|
||||
[Roadmap](https://code.google.com/p/aseprite/wiki/Roadmap).
|
||||
[Roadmap](http://www.aseprite.org/roadmap/).
|
||||
|
||||
42
INSTALL.md
42
INSTALL.md
@ -4,15 +4,17 @@ You should be able to compile Aseprite successfully on the following
|
||||
platforms:
|
||||
|
||||
* Windows + MSVC 2012 + DirectX SDK
|
||||
* Mac OS X 10.8 Mountain Lion + Mac OS X 10.4 SDK universal
|
||||
* Linux + GCC
|
||||
* 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.
|
||||
|
||||
# How can I compile Aseprite?
|
||||
|
||||
The new build system for Aseprite is [CMake](http://www.cmake.org/).
|
||||
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.
|
||||
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.
|
||||
|
||||
The following are the steps to compile Aseprite (in this case we have
|
||||
the source code in a directory called `aseprite-source`):
|
||||
@ -66,6 +68,20 @@ the source code in a directory called `aseprite-source`):
|
||||
can run/debug the program from Visual Studio IDE. On Linux, you can
|
||||
copy the `data/` directory in `~/.aseprite/` directory.
|
||||
|
||||
## Mac OS X details
|
||||
|
||||
You need the old Mac OS X 10.4 SDK universal, which can be obtained
|
||||
from a Xcode 3.2 distribution. You can get it from Apple developer
|
||||
website (you need to be registered):
|
||||
|
||||
https://developer.apple.com/downloads/
|
||||
|
||||
Install the MacOSX10.4.Universal.pkg and run cmake with the following
|
||||
parameters:
|
||||
|
||||
-DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=10.4
|
||||
-DCMAKE_OSX_SYSROOT:STRING=/SDKs/MacOSX10.4u.sdk
|
||||
|
||||
# How to use installed third party libraries?
|
||||
|
||||
If you don't want to use the embedded code of third party libraries
|
||||
@ -81,17 +97,3 @@ that you want to be linked dynamically.
|
||||
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
|
||||
|
||||
# How to compile Aseprite with Mac OS X?
|
||||
|
||||
You need the old Mac OS X 10.4 SDK universal, which can be obtained
|
||||
from a Xcode 3.2 distribution. You can get it from Apple developer
|
||||
website (you need to be registered):
|
||||
|
||||
https://developer.apple.com/downloads/
|
||||
|
||||
Install the MacOSX10.4.Universal.pkg and run cmake with the following
|
||||
parameters:
|
||||
|
||||
-DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=10.4
|
||||
-DCMAKE_OSX_SYSROOT:STRING=/SDKs/MacOSX10.4u.sdk
|
||||
|
||||
Loading…
Reference in New Issue
Block a user