pidgin/pidgin

Refresh the README as a few things have moved and some of the wording was weird.

2021-03-19, Gary Kramlich
b09ca0df70cb
Parents 54b2a95ac176
Children 1cfdaf481246
Refresh the README as a few things have moved and some of the wording was weird.

Testing Done:
Read it a few times.

Reviewed at https://reviews.imfreedom.org/r/568/
1 files changed, 51 insertions(+), 47 deletions(-)
  • +51 -47
    README
    • --- a/README Wed Mar 17 04:13:27 2021 -0500
    +++ b/README Fri Mar 19 02:46:44 2021 -0500
    @@ -1,67 +1,71 @@
    # Purple, Pidgin and Finch
    +
    +libpurple is a library intended to be used by programmers seeking to write an
    +IM client that connects to many IM networks. It comes with support for Bonjour,
    +IRC, and XMPP, among others and there are many more networks supported via
    +[third party plugins](https://pidgin.im/plugins/).
    +
    +Pidgin is a graphical IM client written in C, which uses the GTK toolkit.
    +
    +Finch is a text-based IM client written in C, which uses
    +[libgnt](https://keep.imfreedom.org/libgnt/libgnt).
    +
    +These programs are not endorsed by, nor affiliated with, any proprietary
    +instant messaging company in any way.
    +
    +## Contributors
    +
    See AUTHORS and COPYRIGHT for the list of contributors.
    -libpurple is a library intended to be used by programmers seeking
    -to write an IM client that connects to many IM networks. It comes
    -with support for Bonjour, IRC, XMPP, among others, and there are
    -many more networks supported via third party protocols.
    +## Building
    -Pidgin is a graphical IM client written in C which uses the GTK+
    -toolkit.
    +Pidgin uses [Meson](https://mesonbuild.com) as its build system. There is a
    +long list of dependencies that is not currently documented here due to
    +differences in package names across operating systems. We plan to fix this
    +soon, if you have any suggestions on how to handle this, please let us know.
    -Finch is a text-based IM client written in C which uses the ncurses
    -toolkit.
    -
    -These programs are not endorsed by, nor affiliated with, any
    -proprietary instant messaging company in any way.
    +You can quickly build Pidgin with the following commands:
    -## BUILD
    -
    -Pidgin uses [meson](https://mesonbuild.com) as a build system.
    -
    -You can quickly build Pidgin with the following commands
    +```
    +meson build
    +cd build
    +ninja
    +ninja install
    +```
    - meson build
    - cd build
    - ninja
    - ninja install
    +There are quite a few options for the build that you can view by running
    +`meson configure` in your build directory. You can specify the options when
    +running meson like the following:
    -There are quite a few 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:
    +```
    +meson -Ddebug=true build
    +```
    - meson -Ddebug=true build
    +If you have already run `meson` you can use `meson configure`:
    -If you've already ran meson you can use `meson configure`
    -
    - cd build
    - meson configure -Ddebug=true
    +```
    +cd build
    +meson configure -Ddebug=true
    +```
    -## RUN
    +## Running
    -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'. If it fails to launch you may need to run `ldconfig` as root.
    +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 `pidgin3` or
    +`finch3`. If it fails to launch you may need to run `ldconfig` as root.
    To get started, simply add a new account.
    -If you come across a bug, please report it at: https://developer.pidgin.im/
    -
    -## PLUGINS
    +If you come across a bug, please report it at:
    +[issues.imfreedom.org/issues/PIDGIN](https://issues.imfreedom.org/issues/PIDGIN)
    -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.
    +## Plugins
    -`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.
    +libpurple, Pidgin, and Finch ship with a number of plugins, but you can find
    +additional third party plugins at
    +[pidgin.im/plugins](https://pidgin.im/plugins).
    ## Developing
    -There is a ton of information on developing Pidgin available at
    -[developer.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.
    +You can find more information about Pidgin development in the
    +[development section](https://pidgin.im/development/) of our website.