README

Mon, 07 Aug 2023 23:21:08 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 07 Aug 2023 23:21:08 -0500
changeset 42266
f521c4c38c6e
parent 42252
d14dbdad20e8
child 42565
c035e2eba80d
permissions
-rw-r--r--

Add PurpleProtocolContactSearchInterface to search for contacts

This interface is meant for you to be able to search for new contacts to add to
your contact list. Right now this just does keyword search, but can be extended
in the future.

Searching through your contact list is the ui's responsibility.

Testing Done:
Ran the unit tests

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

42232
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
1 [![pidgin wordmark](img/wordmark.png)](https://pidgin.im/)
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
2
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
3 # 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
4
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 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
6 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
7 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
8 [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
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 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
11
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 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
13 [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
14
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 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
16 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
17
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
18 ## 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
19
15998
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
diff changeset
20 See AUTHORS and COPYRIGHT for the list of contributors.
294277e634fc More gaim->whatever isms
Mark Doliner <markdoliner@pidgin.im>
parents: 15371
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 ## Building
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
23
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
24 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
25 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
26 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
27 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
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 You can quickly build Pidgin with the following commands:
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
30
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
31 ```
41844
5181a1b3cf8d Update the documentation to use meson setup instead of a bare meson
Gary Kramlich <grim@reaperworld.com>
parents: 40820
diff changeset
32 meson setup build
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
33 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
34 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
35 ```
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
36
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
37 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
38 `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
39 running meson like the following:
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
40
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
41 ```
41844
5181a1b3cf8d Update the documentation to use meson setup instead of a bare meson
Gary Kramlich <grim@reaperworld.com>
parents: 40820
diff changeset
42 meson setup -Ddebug=true build
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
43 ```
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
44
41844
5181a1b3cf8d Update the documentation to use meson setup instead of a bare meson
Gary Kramlich <grim@reaperworld.com>
parents: 40820
diff changeset
45 If you have already run `meson setup` 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
46
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
47 ```
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 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
49 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
50 ```
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
51
42252
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
52 ## Installing/Running
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
53
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
54 Previously while developing in our code base you would need to install
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
55 everything to be able to run or test anything. With meson this is no longer the
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
56 case. You can compile via the steps above, and then run directly from the build
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
57 directory with the following command to run Pidgin 3:
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
58
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
59 ```
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
60 cd build
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
61 meson devenv pidgin3
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
62 ```
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
63
42252
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
64 If you're working against Finch 3 you can use:
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
65
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
66 ```
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
67 cd build
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
68 meson devenv finch3
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
69 ```
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
70
42252
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
71 Obviously you're still free to install into your system directly, but then
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
72 you'll most likely end up having orphaned files laying around that our build
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
73 system doesn't know how to remove once they're removed from our code base. This
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
74 is one of the primary reasons we recommend building and running from a devenv.
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
75 Another benefit is that the devenv uses a configuration directory inside of
d14dbdad20e8 Update the build/run instructions to use the devenv
Gary Kramlich <grim@reaperworld.com>
parents: 42232
diff changeset
76 the build directory rather than in your home directory.
1400
a12d24a021f6 [gaim-migrate @ 1410]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 1161
diff changeset
77
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
78 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
79 [issues.imfreedom.org/issues/PIDGIN](https://issues.imfreedom.org/issues/PIDGIN)
0
7b1da07f853f [gaim-migrate @ 9]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
80
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
81 ## Plugins
2318
2e5108f70338 [gaim-migrate @ 2328]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2142
diff changeset
82
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
83 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
84 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
85 [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
86
404f31ce0254 Move most of the docs to just the readme and rewrite it as markdown
Gary Kramlich <grim@reaperworld.com>
parents: 38240
diff changeset
87 ## Developing
2862
962a6d4da169 [gaim-migrate @ 2875]
Eric Warmenhoven <warmenhoven@yahoo.com>
parents: 2777
diff changeset
88
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
89 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
90 [development section](https://pidgin.im/development/) of our website.
42232
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
91
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
92 ## Sponsors
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
93
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
94 Pidgin is supported by DigitalOcean who graciously sponsors all of our
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
95 infrastructure.
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
96
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
97 [![DigitalOcean referal link](img/DO_Logo_horizontal_blue.png)](https://www.digitalocean.com/?refcode=b69e5dddf595&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)
998345e3b714 Add a note about the DigitalOcean Sponsorship to the readme as well as our logo
Gary Kramlich <grim@reaperworld.com>
parents: 41844
diff changeset
98

mercurial