qulogic/gplugin

Clean up a bunch of the package documentation
feature/packaging-housekeeping
2020-02-03, Gary Kramlich
52bd4a1b8d9e
Parents cc89e2f67a59
Children 040e6eb8597a
Clean up a bunch of the package documentation
4 files changed, 28 insertions(+), 21 deletions(-)
  • +9 -6
    HACKING
  • +10 -8
    HACKING.OSX
  • +4 -4
    HISTORY.md
  • +5 -3
    INSTALL.md
    • --- a/HACKING Mon Feb 03 03:30:47 2020 -0600
    +++ b/HACKING Mon Feb 03 03:44:17 2020 -0600
    @@ -7,13 +7,16 @@
    fixes. When a release is deemed done, it's merged back into develop and into
    default. hgflow takes care of all of this for us.
    -To add a feature please fork https://bitbucket.org/gplugin/gplugin. Then clone
    -your fork. Once you have your fork cloned and hgflow setup and installed, type
    +To add a feature please clone `https://keep.imfreedom.org/gplugin/gplugin`.
    +Once you have your fork cloned and hgflow setup and installed, type:
    - hg flow feature start $NAME_OF_YOUR_FEATURE$
    +```
    +hg flow feature start $NAME_OF_YOUR_FEATURE$
    +```
    -This will create a new branch for you to do your work on. When you submit a
    -pull request, make sure it's this branch that you're requesting I pull.
    +This will create a new branch for you to do your work on. When your work hhas
    +been completed, please open a review request at
    +[reviews.imfreedom.org](https://reviews.imfreedom.org).
    -[1] https://bitbucket.org/yujiewu/hgflow
    +[1] https://hg.sr.ht/~wu/hgflow
    --- a/HACKING.OSX Mon Feb 03 03:30:47 2020 -0600
    +++ b/HACKING.OSX Mon Feb 03 03:44:17 2020 -0600
    @@ -14,25 +14,27 @@
    ninja
    ```
    -Lua
    -===
    +## Lua
    For the Lua loader to work, you need to install lgi from luarocks either
    systemwide or to a virtual environment created by LuaDist, vert, or something
    along those lines.
    When you're building lgi against homebrew you'll have to set the
    -PKG_CONFIG_PATH environment variable since homebrew does not install libffi
    +`PKG_CONFIG_PATH` environment variable since homebrew does not install libffi
    systemwide. This is easily done via:
    - export PKG_CONFIG_PATH=$(brew --prefix libffi)/lib/pkgconfig
    +```
    +export PKG_CONFIG_PATH=$(brew --prefix libffi)/lib/pkgconfig
    +```
    -and then running "luarocks install lgi"
    +and then running `luarocks install lgi`.
    -PYTHON
    -======
    +## Python
    If you're using homebrew, you need to install pygobject3 with
    - brew install pygobject3 --with-python3
    +```
    +brew install pygobject3 --with-python3
    +```
    --- a/HISTORY.md Mon Feb 03 03:30:47 2020 -0600
    +++ b/HISTORY.md Mon Feb 03 03:44:17 2020 -0600
    @@ -32,10 +32,10 @@
    but come on, that should be a one time cost to the library author, instead of
    an additional startup cost to the plugin author. STRIKE TWO!
    -So with two strikes down, I continued researching libpeas, by now working on a
    -plugin for rhythmbox, and just found the API to be clunky and poorly
    -documented. Now maybe I just wasn't finding the write documentation, but this
    -was STRIKE THREE!
    +So with two strikes down, I continued researching libpeas, and discovered that
    +you can only use one language other than the native loader. We, the Pidgin,
    +developers have always aimed to support as many languages as possible, and this
    +just wasn't going to cut it. So there was STRIKE THREE!
    Libpeas had struck out for me, and as such I started GPlugin the very next day!
    --- a/INSTALL.md Mon Feb 03 03:30:47 2020 -0600
    +++ b/INSTALL.md Mon Feb 03 03:44:17 2020 -0600
    @@ -1,6 +1,7 @@
    # Dependencies
    GPlugin depends on the following at a bare minimum:
    +
    * glib-2.0 >= 2.40.0
    * gobject-introspection, libgirepository1.0-dev
    * meson >= 0.42.0
    @@ -9,6 +10,7 @@
    * a C compiler
    A full build (enabled by default) depends on the following:
    +
    * gtk-3
    * python3-dev, python-gi-dev, python3-gi
    * liblua5.1-0-dev, lua-lgi
    @@ -20,8 +22,8 @@
    # Building
    GPlugin uses meson (http://mesonbuild.com/) as its build system. As such
    -compiling is a little bit different than your typical ./configure, make,
    -sudo make install. But luckily for you, not too much different.
    +compiling is a little bit different than your typical `./configure`, `make`,
    +`sudo make install`.
    Meson requires you to build in a separate directory than your source. As such,
    these instructions use a separate build directory.
    @@ -35,5 +37,5 @@
    ```
    If you want/need to tweak the build system (to enable/disable certain loaders)
    -you can do so at any time by using mesonconf in the build directory.
    +you can do so at any time by using `meson configure` in the build directory.