README

Tue, 23 Aug 2022 04:29:09 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Tue, 23 Aug 2022 04:29:09 -0500
branch
gtk4
changeset 41582
4ee4a8ddc190
parent 40820
b09ca0df70cb
child 41844
5181a1b3cf8d
permissions
-rw-r--r--

Explicitly set show-menubar so our menubars are shown

Testing Done:
Ran and verified the menus are displayed. Shortcut keys aren't working either so that might be part of the issue why they're not showing up with the ui file being set?

Reviewed at https://reviews.imfreedom.org/r/1635/

38769
404f31ce0254 Move most of the docs to just the readme and rewrite it as markdown
Gary Kramlich <grim@reaperworld.com>
parents: 38240
diff changeset
1 # Purple, Pidgin and Finch
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
2
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
3 libpurple is a library intended to be used by programmers seeking to write an
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
4 IM client that connects to many IM networks. It comes with support for Bonjour,
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
5 IRC, and XMPP, among others and there are many more networks supported via
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
6 [third party plugins](https://pidgin.im/plugins/).
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
7
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
8 Pidgin is a graphical IM client written in C, which uses the GTK toolkit.
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
9
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
10 Finch is a text-based IM client written in C, which uses
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
11 [libgnt](https://keep.imfreedom.org/libgnt/libgnt).
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
12
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
13 These programs are not endorsed by, nor affiliated with, any proprietary
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
14 instant messaging company in any way.
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
15
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
16 ## Contributors
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
17
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
18 See AUTHORS and COPYRIGHT for the list of contributors.
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
19
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
20 ## Building
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
21
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
22 Pidgin uses [Meson](https://mesonbuild.com) as its build system. There is a
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
23 long list of dependencies that is not currently documented here due to
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
24 differences in package names across operating systems. We plan to fix this
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
25 soon, if you have any suggestions on how to handle this, please let us know.
2608
af4b9ddb6365 [gaim-migrate @ 2621]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2536
diff changeset
26
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
27 You can quickly build Pidgin with the following commands:
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
28
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
29 ```
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
30 meson build
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
31 cd build
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
32 ninja
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
33 ninja install
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
34 ```
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
35
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
36 There are quite a few options for the build that you can view by running
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
37 `meson configure` in your build directory. You can specify the options when
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
38 running meson like the following:
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
39
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
40 ```
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
41 meson -Ddebug=true build
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
42 ```
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
43
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
44 If you have already run `meson` you can use `meson configure`:
38769
404f31ce0254 Move most of the docs to just the readme and rewrite it as markdown
Gary Kramlich <grim@reaperworld.com>
parents: 38240
diff changeset
45
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
46 ```
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
47 cd build
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
48 meson configure -Ddebug=true
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
49 ```
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
50
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
51 ## Running
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
52
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
53 Currently Pidgin can not be run from a build directory, which means you must
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
54 install it first. Once you've done that, you only need to run `pidgin3` or
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
55 `finch3`. If it fails to launch you may need to run `ldconfig` as root.
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
56
16237
606a402fea87 Beat some older documentation into submission.
Richard Laager <rlaager@pidgin.im>
parents: 16002
diff changeset
57 To get started, simply add a new account.
1400
a12d24a021f6 [gaim-migrate @ 1410]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 1161
diff changeset
58
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
59 If you come across a bug, please report it at:
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
60 [issues.imfreedom.org/issues/PIDGIN](https://issues.imfreedom.org/issues/PIDGIN)
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
61
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
62 ## Plugins
2318
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
63
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
64 libpurple, Pidgin, and Finch ship with a number of plugins, but you can find
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
65 additional third party plugins at
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
66 [pidgin.im/plugins](https://pidgin.im/plugins).
38769
404f31ce0254 Move most of the docs to just the readme and rewrite it as markdown
Gary Kramlich <grim@reaperworld.com>
parents: 38240
diff changeset
67
404f31ce0254 Move most of the docs to just the readme and rewrite it as markdown
Gary Kramlich <grim@reaperworld.com>
parents: 38240
diff changeset
68 ## Developing
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
69
40820
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
70 You can find more information about Pidgin development in the
b09ca0df70cb Refresh the README as a few things have moved and some of the wording was weird.
Gary Kramlich <grim@reaperworld.com>
parents: 40201
diff changeset
71 [development section](https://pidgin.im/development/) of our website.

mercurial