qulogic/pidgin

Parents ed83a5f7003c
Children 4b9ab59e1c6d
Move most of the docs to just the readme and rewrite it as markdown
  • +0 -2
    HACKING
  • +0 -220
    INSTALL
  • +0 -7
    PLUGIN_HOWTO
  • +38 -35
    README
  • --- a/HACKING Thu Oct 26 22:21:55 2017 -0500
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,2 +0,0 @@
    -For information on hacking on Pidgin, Finch, or libpurple, see:
    - https://developer.pidgin.im
    --- a/INSTALL Thu Oct 26 22:21:55 2017 -0500
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,220 +0,0 @@
    -Basic Installation
    -==================
    -
    - These are generic installation instructions.
    -
    - The `configure' shell script attempts to guess correct values for
    -various system-dependent variables used during compilation. It uses
    -those values to create a `Makefile' in each directory of the package.
    -It may also create one or more `.h' files containing system-dependent
    -definitions. Finally, it creates a shell script `config.status' that
    -you can run in the future to recreate the current configuration, a file
    -`config.cache' that saves the results of its tests to speed up
    -reconfiguring, and a file `config.log' containing compiler output
    -(useful mainly for debugging `configure').
    -
    - If you need to do unusual things to compile the package, please try
    -to figure out how `configure' could check whether to do them, and mail
    -diffs or instructions to the address given in the `README' so they can
    -be considered for the next release. If at some point `config.cache'
    -contains results you don't want to keep, you may remove or edit it.
    -
    - The file `configure.ac' is used to create `configure' by a program
    -called `autoconf'. You only need `configure.ac' if you want to change
    -it or regenerate `configure' using a newer version of `autoconf'.
    -
    -The simplest way to compile this package is:
    -
    - 1. `cd' to the directory containing the package's source code and type
    - `./configure' to configure the package for your system. If you're
    - using `csh' on an old version of System V, you might need to type
    - `sh ./configure' instead to prevent `csh' from trying to execute
    - `configure' itself.
    -
    - Running `configure' takes awhile. While running, it prints some
    - messages telling which features it is checking for. If it finishes
    - successfully, it will print out of a summary of the build options.
    - This summary will also appear in the help->about dialog.
    -
    - 2. Type `make' to compile the package. On some systems, you may need
    - to use `gmake' instead.
    -
    - 3. Optionally, type `make check' to run any self-tests that come with
    - the package.
    -
    - 4. Type `make install' to install the programs and any data files and
    - documentation. You must have write access to the prefix you are
    - installing to. See below for more details on the prefix.
    -
    - 5. You can remove the program binaries and object files from the
    - source code directory by typing `make clean'. To also remove the
    - files that `configure' created (so you can compile the package for
    - a different kind of computer), type `make distclean'. There is
    - also a `make maintainer-clean' target, but that is intended mainly
    - for the package's developers. If you use it, you may have to get
    - all sorts of other programs in order to regenerate files that came
    - with the distribution.
    -
    - 6. If you have *not* run make distclean, you can use the target
    - `make uninstall` to remove the files installed by `make install`.
    -
    -Compilers and Options
    -=====================
    -
    - Some systems require unusual options for compilation or linking that
    -the `configure' script does not know about. You can give `configure'
    -initial values for variables by setting them in the environment. Using
    -a Bourne-compatible shell, you can do that on the command line like
    -this:
    - CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
    -
    -Or on systems that have the `env' program, you can do it like this:
    - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
    -
    -Compiling For Multiple Architectures
    -====================================
    -
    - You can compile the package for more than one kind of computer at the
    -same time, by placing the object files for each architecture in their
    -own directory. To do this, you must use a version of `make' that
    -supports the `VPATH' variable, such as GNU `make'. `cd' to the
    -directory where you want the object files and executables to go and run
    -the `configure' script. `configure' automatically checks for the
    -source code in the directory that `configure' is in and in `..'.
    -
    - If you have to use a `make' that does not supports the `VPATH'
    -variable, you have to compile the package for one architecture at a time
    -in the source code directory. After you have installed the package for
    -one architecture, use `make distclean' before reconfiguring for another
    -architecture.
    -
    -Installation Names
    -==================
    -
    - By default, `make install' will install the package's files in
    -`/usr/local/bin', `/usr/local/man', etc. You can specify an
    -installation prefix other than `/usr/local' by giving `configure' the
    -option `--prefix=PATH'.
    -
    - You can specify separate installation prefixes for
    -architecture-specific files and architecture-independent files. If you
    -give `configure' the option `--exec-prefix=PATH', the package will use
    -PATH as the prefix for installing programs and libraries.
    -Documentation and other data files will still use the regular prefix.
    -
    - In addition, if you use an unusual directory layout you can give
    -options like `--bindir=PATH' to specify different values for particular
    -kinds of files. Run `configure --help' for a list of the directories
    -you can set and what kinds of files go in them.
    -
    - If the package supports it, you can cause programs to be installed
    -with an extra prefix or suffix on their names by giving `configure' the
    -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
    -
    -Optional Features
    -=================
    -
    - Some packages pay attention to `--enable-FEATURE' options to
    -`configure', where FEATURE indicates an optional part of the package.
    -They may also pay attention to `--with-PACKAGE' options, where PACKAGE
    -is something like `gnu-as' or `x' (for the X Window System). The
    -`README' should mention any `--enable-' and `--with-' options that the
    -package recognizes.
    -
    - For packages that use the X Window System, `configure' can usually
    -find the X include and library files automatically, but if it doesn't,
    -you can use the `configure' options `--x-includes=DIR' and
    -`--x-libraries=DIR' to specify their locations.
    -
    - By default both the GTK+ UI (Pidgin) and the ncurses UI (Finch) will be
    -built, assuming that configure finds the necessary libraries and headers for
    -each. You can disable the GTK+ UI with `--disable-gtkui' and the ncurses UI
    -with `--disable-consoleui'.
    -
    - `--disable-screensaver' will build libpurple without support for detecting
    -when it should mark accounts idle based on mouse or keyboard usage.
    -
    - `--disable-sm' will build without support for the X session management.
    -Doing so will remove the ability to have pidgin start up with your window
    -manager.
    -
    - `--disable-gevolution' will cause the evolution integration plugin not to
    -compile.
    -
    - `--disable-gstreamer' will build without sound support. This applies to
    -*both* Pidgin and Finch.
    -
    - `--enable-gnutls=yes,no' will enable or disable the use of gnutls for ssl support. Disabling both gnutls and nss will mean you cannot use either MSN or Google Talk. There is no static option for gnutls at this time.
    -
    - `--enable-nss=yes,no,static' will enable or disable the use of nss for ssl support. This is the only option for ssl support if you are attempting to compile a static version of Pidgin or Finch.
    -
    -Optional Packages:
    -
    -
    - `--with-static-prpls' takes a list of comma separated protocols to build in statically (rather than as plugins). Use this with care.
    -
    - `--with-dynamic-prpls' takes a list of comma separated protocols also. If used only those listed will be built. If no protocols are listed with either `--with-static-prpls' or with `--with-dynamic-prpls' then Pidgin and Finch will be effectively useless.
    -
    - If configure does not find python, it will build without DBUS support. This will disable scripts such as purple-remote and purple-uri-handler, effectively disabling integration with the browser. You can tell configure where your python binary is located with `--with-python=PATH'
    -
    -Specifying the System Type
    -==========================
    -
    - There may be some features `configure' can not figure out
    -automatically, but needs to determine by the type of host the package
    -will run on. Usually `configure' can figure that out, but if it prints
    -a message saying it can not guess the host type, give it the
    -`--host=TYPE' option. TYPE can either be a short name for the system
    -type, such as `sun4', or a canonical name with three fields:
    - CPU-COMPANY-SYSTEM
    -
    -See the file `config.sub' for the possible values of each field. If
    -`config.sub' isn't included in this package, then this package doesn't
    -need to know the host type.
    -
    - If you are building compiler tools for cross-compiling, you can also
    -use the `--target=TYPE' option to select the type of system they will
    -produce code for and the `--build=TYPE' option to select the type of
    -system on which you are compiling the package.
    -
    -Sharing Defaults
    -================
    -
    - If you want to set default values for `configure' scripts to share,
    -you can create a site shell script called `config.site' that gives
    -default values for variables like `CC', `cache_file', and `prefix'.
    -`configure' looks for `PREFIX/share/config.site' if it exists, then
    -`PREFIX/etc/config.site' if it exists. Or, you can set the
    -`CONFIG_SITE' environment variable to the location of the site script.
    -A warning: not all `configure' scripts look for a site script.
    -
    -Operation Controls
    -==================
    -
    - `configure' recognizes the following options to control how it
    -operates.
    -
    -`--cache-file=FILE'
    - Use and save the results of the tests in FILE instead of
    - `./config.cache'. Set FILE to `/dev/null' to disable caching, for
    - debugging `configure'.
    -
    -`--help'
    - Print a summary of the options to `configure', and exit.
    -
    -`--quiet'
    -`--silent'
    -`-q'
    - Do not print messages saying which checks are being made. To
    - suppress all normal output, redirect it to `/dev/null' (any error
    - messages will still be shown).
    -
    -`--srcdir=DIR'
    - Look for the package's source code in directory DIR. Usually
    - `configure' can determine that directory automatically.
    -
    -`--version'
    - Print the version of Autoconf used to generate the `configure'
    - script, and exit.
    -
    -`configure' also accepts some other, not widely useful, options. Many of these are related to having various optional libaries installed to locations outside of your path.
    --- a/PLUGIN_HOWTO Thu Oct 26 22:21:55 2017 -0500
    +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
    @@ -1,7 +0,0 @@
    -For information on writing a plugin for Purple, Pidgin or Finch, go
    -https://developer.pidgin.im and click on API. From there, see the
    -HOWTOs in the "Related Pages" section.
    -
    -You can also generate this documentation locally by passing
    -"--enable-gtk-doc" to ./configure, then running "make" in the source tree.
    -The documentation will be in the doc/reference/*/html directories.
    --- a/README Thu Oct 26 22:21:55 2017 -0500
    +++ b/README Thu Oct 26 22:26:12 2017 -0500
    @@ -1,5 +1,4 @@
    -Purple, Pidgin and Finch
    -========================
    +# Purple, Pidgin and Finch
    See AUTHORS and COPYRIGHT for the list of contributors.
    libpurple is a library intended to be used by programmers seeking
    @@ -15,49 +14,53 @@
    These programs are not endorsed by, nor affiliated with, AOL nor any
    other company in any way.
    -BUILD
    -=====
    +## BUILD
    +
    +Pidgin uses [meson](https://mesonbuild.com) as a build system.
    +
    +You can quickly build Pidgin with the following commands
    -Read the 'INSTALL' file for more detailed directions.
    + meson build
    + cd build
    + ninja
    + sudo ninja install
    -These programs use the standard ./configure ; make. You need to use
    -gmake, BSD make probably won't work. Remember, run ./configure --help
    -to see what build options are available.
    +There are a boat load of options for the build that you can view by looking at `meson_options.txt`. You can specify the options when running meson like the following:
    -In order to compile Pidgin you need to have GTK+ 2.0 installed (as
    -well as the development files!). The configure script will fail if you
    -don't. If you don't have GTK+ 2.0 installed, you should install it
    -using your distribution's package management tools.
    + meson -Ddebug=true build
    +
    +If you've already ran meson you can use `meson configure`
    -For sound support, you also need gstreamer 0.10 or higher.
    -Your distro of choice probably already includes these, just be sure to
    -install the development packages.
    + cd build
    + meson configure -Ddebug=true
    -RUN
    -===
    +## RUN
    -You should run 'make install' as root to make sure plugins and other files
    -get installed into locations they want to be in. Once you've done that,
    -you only need to run 'pidgin' or 'finch'.
    +Currently Pidgin can not be run from a build directory which means you must
    +install it first. Once you've done that, you only need to run 'pidgin' or
    +'finch'.
    To get started, simply add a new account.
    -If you come across a bug, please report it at: https://developer.pidgin.im
    +If you come across a bug, please report it at: https://developer.pidgin.im/
    +
    +## PLUGINS
    -PLUGINS
    -=======
    -
    -If you do not wish to enable the plugin support within Purple, run the
    -./configure script with the --disable-plugins option and recompile your
    -source code. This will prevent the ability to load plugins.
    +If you do not wish to enable the plugin support within Purple, run meson with
    +`-Dplugins=false` or if you've already ran meson use
    +`meson configure -Dplugins=false` from the build directory. This will prevent
    +the ability to load plugins.
    -'make install' puts the plugins in $PREFIX/lib/purple (PREFIX being what
    -you specified when you ./configure'd - it defaults to /usr/local). Purple
    +`ninja install` puts the plugins in `$PREFIX/lib/purple` (PREFIX being what
    +you specified when you ran meson. It defaults to `/usr/local`). Purple
    looks for the plugins in that directory by default. Plugins can be installed
    -per-user in ~/.purple/plugins as well. Pidgin and Finch also look in
    -$PREFIX/lib/pidgin and $PREFIX/lib/finch for UI-specific, respectively.
    +per-user in `~/.purple/plugins` as well. Pidgin and Finch also look in
    +`$PREFIX/lib/pidgin` and `$PREFIX/lib/finch` for UI-specific, respectively.
    +
    +## Developing
    -To build a plugin from a .c file, put it in the plugins/ directory in
    -the source and run 'make filename.so', e.g. if you have the .c file
    -'kickass.c', put it in the plugins/ directory, and from that directory,
    -run 'make kickass.so'.
    \ No newline at end of file
    +There is a ton of information on developing Pidgin available at
    +[develop.pidgin.im](https://developer.pidgin.im).
    +
    +To generate the documentation locally you can pass `-Ddoc=true` to `meson` or
    +`meson configure` which will build the `gtk-docs` for everything.