README: add dependencies and manual instalation sections

This commit is contained in:
Juan Pablo Ugarte 2021-12-18 15:41:03 -05:00
parent 8e7871ed30
commit c4d434a570

View File

@ -24,6 +24,15 @@ Source code lives on GNOME gitlab [here](https://gitlab.gnome.org/jpu/cambalache
`git clone https://gitlab.gnome.org/jpu/cambalache.git`
## Dependencies
* Python 3 - Cambalache is written in Python
* [Meson](http://mesonbuild.org) build system
* [GTK](http://www.gtk.org) 3 and 4 with broadway backend enabled
* python-gi - Python GTK bindings
* python3-lxml - Python libxml2 bindings
* WebkitGTK - Webview for workspace
## Running from sources
To run it without installing use run-dev.py script, it will automatically compile
@ -55,6 +64,26 @@ flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flath
flatpak install --user flathub ar.xjuan.Cambalache
```
## Manual installation
This is a regular meson package and can be installed the usual way.
```
# Create build directory and configure project
mkdir _build && cd _build
meson --prefix=~/.local
# Build and install
ninja
ninja install
```
To run it from .local/ you might need to setup PYTHONPATH env variable depending
on your distribution defaults
```
export PYTHONPATH=.local/lib/python3/dist-packages/
```
## Contributing
If you are interested in contributing you can open and issue [here](https://gitlab.gnome.org/jpu/cambalache/-/issues)