Update readmes

This commit is contained in:
Cassowary 2023-09-25 16:23:56 -07:00
parent 891e999216
commit ebd17a1e10
2 changed files with 179 additions and 102 deletions

174
README
View File

@ -1,107 +1,77 @@
------------------------------
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.
Photo and Image Kooker App (Pika)
If you want to hack on PIKA, please read the file devel-docs/README.md.
For detailed installation instructions, see the file INSTALL.
a fork of
Gnu Image Manipulation Program
created with
Heckimp
brought to you by Aldercone Studio
http://aldercone.studio
http://heckin.technology
-------------------------------------------------------------------------------
This fork was prepared from the GnuImp unstable branch. It works reasonably well, though.
Presently python and vala scripts don't seem to be working due to bugs upstream. We'll
keep abreast upstream though.
Build instructions (Linux / Unix-likes):
You will need gegl and babl, and to build newish version of them. The easiest way to do
this is to go to the respective homepages, clone the source and build them as instructed.
https://www.gegl.org/babl/
https://www.gegl.org/
On some systems libbabl and libgegl might be up to date enough to use the system packages
but they are somewhat tightly coupled.
Once that is installed, Pika can be built from source. You will also need relatively
recent GTK3 development libraries and numerous other libraries for file format support and
similar.
Partial package list on Debian/Ubuntu/etc:
appstream-util bison build-essential cmake desktop-file-utils flex gjs libaa1-dev libappstream-glib-dev libarchive-dev
libatk1.0-dev libcairo2-dev libcfitsio-dev libexiv2-dev libfontconfig-dev libfreetype-dev libgdk-pixbuf-2.0-dev
libgexiv2-dev libglib2.0-dev libgs-dev libgtk-3-dev libgudev-1.0-dev libharfbuzz-dev libheif-dev libjpeg-dev
libjson-glib-dev liblcms2-dev libmng-dev libmypaint-dev libopenexr-dev libopenjp2-7-dev libpango1.0-dev libpng-dev
libpoppler-dev libpoppler-glib-dev librsvg2-dev libtiff-dev libunwind-dev libwebp-dev libwmf-dev libx11-dev
libxcursor-dev libxext-dev libxfixes-dev libxmu-dev libxpm-dev libzstd-dev luajit meson mypaint-brushes ninja-build
pappler-data python3-gi-dev xmllint xsltproc
Seems like a lot! But many of these are for format support. This is for the maximal setup we've tested.
Once those are installed, it's time to build!
First run meson to make the build files:
meson _build --prefix=/usr/local --buildtype=release -Dpython=enabled -Dvala=disabled -Dgi-docgen=disabled
This will also tell you if you're missing important bits. We disable vala and gi-docgen because they fail currently,
the docgen perhaps is something we can fix but haven't yet.
Next you build the actual program by doing:
cd _build
ninja
Then if successful, install with
sudo ninja install
And that's it! Pika should show up in your menu if everything worked out.
If everything didn't work out, let us know, we can probably help! Contact us on fediverse @aldercone@mastodon.art.
If you want to help, contact us also! We'll be keeping synced with upstream as best as possible and working on
containerized builds and builds for other platforms as soon as we can!
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

107
README.orig Normal file
View File

@ -0,0 +1,107 @@
------------------------------
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