imfreedom/contributors-guide

Parents 9c0ff4da827e
Children e43b2bdd8b0e
Make the emphasis of the mercurial page be imf repos not pidgin repos
--- a/docs/mercurial.md Mon May 16 21:37:48 2022 -0500
+++ b/docs/mercurial.md Mon May 16 21:38:10 2022 -0500
@@ -1,45 +1,48 @@
-Title: Using Pidgin Mercurial
-Slug: using-pidgin-mercurial
+Title: Using Mercurial
+Slug: using-mercurial
-## Using Pidgin Mercurial
+# Using Mercurial
-### Introduction
+## Introduction
-These instructions will help you clone a copy of any of the Pidgin
-related [Mercurial](https://mercurial-scm.org)
-repositories and keep them up to date.
+These instructions will help you clone a copy of any of the Instant Messaging
+Freedom hosted [Mercurial](https://mercurial-scm.org) repositories and keep
+them up to date.
-These instructions are just for cloning/updating the Pidgin repositories.
-If you're looking for documentation on contributing code, please see the
-[Code Contributions](code_contributions.html)
-page after you have successfully cloned the repository from this page.
+These instructions are just for cloning/updating the Instant Messaging Freedom
+realated repositories. If you're looking for documentation on contributing
+code, please see the [Code Contributions](code_contributions.md) page after you
+have successfully cloned the repository from this page.
-### Cloning
+## Cloning
In Distributed Version Control, ***cloning*** is the act
-of acquiring a source repository. All of the Pidgin repositories are
-hosted in Mercurial at
-[keep.imfreedom.org](https://keep.imfreedom.org/). To
-clone them you will be using the command
-`hg clone <URL>`. The specific URL can be looked up in
-the table below depending what you are trying to clone.
+of acquiring a source repository. All of the Instant Messaging Freedom related
+repositories are hosted in Mercurial at
+[keep.imfreedom.org](https://keep.imfreedom.org/). To clone them you will be
+using the command `hg clone <URL>`. The specific URL can be looked up in the
+table below depending what you are trying to clone.
> If you are trying to build Pidgin 3, you can just clone that repository and
> the build system will automatically clone the other repositories for you.
-#### Repositories
+### Repositories
-[https://keep.imfreedom.org/gplugin/gplugin/](https://keep.imfreedom.org/gplugin/gplugin/)
-: The plugin library used in Pidgin 3.
+| Repository | Description |
+| ---------- | ----------- |
+| [keep.imfreedom.org/gplugin/gplugin/](https://keep.imfreedom.org/gplugin/gplugin/) | The plugin library used in Pidgin 3. |
+| [keep.imfreedom.org/libgnt/libgnt/](https://keep.imfreedom.org/libgnt/libgnt/) | The toolkit library used in Finch. |
+| [keep.imfreedom.org/pidgin/pidgin/](https://keep.imfreedom.org/pidgin/pidgin/) | The main Pidgin repository. |
+| [keep.imfreedom.org/talkatu/talkatu/](https://keep.imfreedom.org/talkatu/talkatu/) | The conversation widgets used in Pidgin 3. |
-[https://keep.imfreedom.org/libgnt/libgnt/](https://keep.imfreedom.org/libgnt/libgnt/)
-: The toolkit library used in Finch.
+There are additional repositories under
+[gplugin/](https://keep.imfreedom.org/gplugin/),
+[libgnt/](https://keep.imfreedom.org/libgnt/),
+[imfreedom/](https://keep.imfreedom.org/imfreedom/),
+and [pidgin/](https://keep.imfreedom.org/pidgin/)
+which contain other miscellaneous things.
-[https://keep.imfreedom.org/pidgin/pidgin/](https://keep.imfreedom.org/pidgin/pidgin/)
-: The main Pidgin repository that contains LibPurple, Pidgin, and Finch.
-
-[https://keep.imfreedom.org/talkatu/talkatu/](https://keep.imfreedom.org/talkatu/talkatu/)
-: The conversation widgets used in Pidgin 3.
+### Example
You can see an example clone of Talkatu below but all of the repositories will
output a similar result.
@@ -57,11 +60,11 @@
109 files updated, 0 files merged, 0 files removed, 0 files unresolved
```
-### Keeping Your Clone Up To Date
+## Keeping Your Clone Up To Date
-If you are just tracking Pidgin development and are not contributing, chances
-are you are still on the ***default*** branch. But let's make sure, and run
-`hg update default`. This will change to the ***default*** branch if you're
+If you are just tracking development and are not contributing, chances are you
+ still on the ***default*** branch. But let's make sure, and run
+ `hg update default`. This will change to the ***default*** branch if you're
not currently on it or do nothing.
Now that you are on the ***default*** branch, you can