PIKApp/upstream-documentation/README.upstream

108 lines
3.4 KiB
Plaintext

------------------------------
Photo and Image Kooker Application
2.99 Development Branch
------------------------------
This is an unstable development release, an intermediate state on the
way to the next stable release: PIKA 3.0. PIKA 2.99 may or may not do
what you expect. Save your work early and often. If you want a stable
version, please use PIKA 2.10 instead.
If you think you found a bug in this version, please make sure that it
hasn't been reported earlier and that it is not just new stuff that is
still being worked on and obviously not quite finished yet.
If you want to hack on PIKA, please read the file devel-docs/README.md.
For detailed installation instructions, see the file INSTALL.
1. Web Resources
================
PIKA's home page is at:
https://heckin.technology/AlderconeStudio/PIKApp/
Please be sure to visit this site for information, documentation,
tutorials, news, etc. All things PIKA-ish are available from there.
The latest version of PIKA can be found at:
https://heckin.technology/AlderconeStudio/PIKApp/downloads/
2. Contributing
===============
PIKA source code can be found at:
https://gitlab.gnome.org/GNOME/pika/
Resources for contributors:
https://developer.pika.org/
In particular, you may want to look in the "Core Development" section. Some
articles of particular interest for newcomers could be:
* Setting up your developer environment: https://developer.pika.org/core/setup/
* PIKA Coding Style: https://developer.pika.org/core/coding_style/
* Submit your first patch: https://developer.pika.org/core/submit-patch/
3. Discussion Channels
======================
We have several discussion channels dedicated to PIKA user and
development discussion. There is more info at:
https://heckin.technology/AlderconeStudio/PIKApp/discuss.html
Links to several archives of the mailing lists are included in that page.
Pika-user-list is a mailing list dedicated to user problems, hints and
tips, discussion of cool effects, etc. Gimp-developer-list is oriented
to PIKA core and plug-in developers. Gimp-gui-list is for discussing
about PIKA interface to improve user experience. Most people will only
want to be subscribed to pika-user-list. If you want to help develop
PIKA, the pika-developer mailing list is a good starting point; if you
want to help with GUI design, the pika-gui list is where you want to
subscribe.
Other discussion channels can be listed on this page when they are
moderated by a team member, such as forums.
Finally, for the real junkies, there are IRC channels devoted to PIKA.
On PIKANet (a private free software oriented network) there is #pika.
Many of the developers hang out there. Some of the PIKANet servers are:
irc.gimp.org:6667
irc.us.gimp.org:6667
irc.eu.gimp.org:6667
4. Customizing
==============
The look of PIKA's interface can be customized like any other GTK+ app
by editing files in `${XDG_CONFIG_HOME}/gtk-3.0/` (settings.ini and
gtk.css in particular) or by using "themes" (ready-made customizations).
Additionally, PIKA reads `${XDG_CONFIG_HOME}/PIKA/2.99/pika.css` so you
can have settings that only apply to PIKA.
You can also manually change the keybindings to any of your choice by
editing: `${XDG_CONFIG_HOME}/PIKA/2.99/shortcutsrc`.
Have fun,
Spencer Kimball
Peter Mattis
Federico Mena
Manish Singh
Sven Neumann
Michael Natterer
Dave Neary
Martin Nordholts
Jehan