Update the build/run instructions to use the devenv

Mon, 31 Jul 2023 22:03:15 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Mon, 31 Jul 2023 22:03:15 -0500
changeset 42252
d14dbdad20e8
parent 42251
63639da06cbd
child 42253
31743d477d97

Update the build/run instructions to use the devenv

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

README file | annotate | diff | comparison | revisions
--- a/README	Wed Jul 19 23:29:37 2023 -0500
+++ b/README	Mon Jul 31 22:03:15 2023 -0500
@@ -32,7 +32,6 @@
 meson setup build
 cd build
 ninja
-ninja install
 ```
 
 There are quite a few options for the build that you can view by running
@@ -50,13 +49,31 @@
 meson configure -Ddebug=true
 ```
 
-## Running
+## Installing/Running
+
+Previously while developing in our code base you would need to install
+everything to be able to run or test anything. With meson this is no longer the
+case. You can compile via the steps above, and then run directly from the build
+directory with the following command to run Pidgin 3:
+
+```
+cd build
+meson devenv pidgin3
+```
 
-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.
+If you're working against Finch 3 you can use:
+
+```
+cd build
+meson devenv finch3
+```
 
-To get started, simply add a new account.
+Obviously you're still free to install into your system directly, but then
+you'll most likely end up having orphaned files laying around that our build
+system doesn't know how to remove once they're removed from our code base. This
+is one of the primary reasons we recommend building and running from a devenv.
+Another benefit is that the devenv uses a configuration directory inside of
+the build directory rather than in your home directory.
 
 If you come across a bug, please report it at:
 [issues.imfreedom.org/issues/PIDGIN](https://issues.imfreedom.org/issues/PIDGIN)

mercurial