mirror/aseprite
1
0
Fork 0
mirror of https://github.com/aseprite/aseprite.git synced 2025-01-13 09:39:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md and INSTALL.md

Browse Source
This commit is contained in:
David Capello 2013-11-23 16:32:13 -03:00
parent 0090be560c
commit 6f50385d5f
2 changed files with 29 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@ -62,6 +62,10 @@ You can clone it locally using the following command (read-only URL):
On Windows you can use programs like On Windows you can use programs like
[msysgit](http://msysgit.github.io/) to clone the repository. [msysgit](http://msysgit.github.io/) to clone the repository.
## Compiling
See [INSTALL.md](INSTALL.md) to know how to compile Aseprite.
## Forking & Pull Requests ## Forking & Pull Requests
You can fork the GitHub repository using the Fork button at You can fork the GitHub repository using the Fork button at
@ -84,6 +88,15 @@ want to fix three different issues, create three different branches
from `dev` and then send three different PR. Do not chain all the from `dev` 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`. fixes in one single branch. E.g. `fix-issues-3-and-8-and-25`.
## Contact ## Mailing List
Ask for help in the [Aseprite group](http://groups.google.com/group/aseprite-discuss). Subscribe to
[aseprite-discuss](http://groups.google.com/group/aseprite-discuss)
group. If you want to start working in something
(e.g. [an open issue](http://code.google.com/p/aseprite/issues/list)),
you should send an email to the group describing what you want to do,
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).

14
INSTALL.md
View File

@ -10,6 +10,10 @@ platforms:
# How can I compile Aseprite? # How can I compile Aseprite?
The new build system for Aseprite is [CMake](http://www.cmake.org/). 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.
The following are the steps to compile Aseprite (in this case we have The following are the steps to compile Aseprite (in this case we have
the source code in a directory called `aseprite-source`): the source code in a directory called `aseprite-source`):
@ -62,6 +66,16 @@ the source code in a directory called `aseprite-source`):
can run/debug the program from Visual Studio IDE. On Linux, you can can run/debug the program from Visual Studio IDE. On Linux, you can
copy the `data/` directory in `~/.aseprite/` directory. copy the `data/` directory in `~/.aseprite/` directory.
# How to use installed third party libraries?
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 edit `build/CMakeCache.txt` file, and
enable the `USE_SHARED_` flag (set its value to `ON`) of the library
that you want to be linked dynamically.
# How to profile Aseprite? # How to profile Aseprite?
You must compile with `Profile` configuration. For example on Linux: You must compile with `Profile` configuration. For example on Linux: