README.md 1.44 KB
Newer Older
Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
1
2
# WFlow

Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
3
4
5
6
7
8
9
10
11
12
Collection of packages required for my workflow. In particular, this project is for user installation of these packages on systems I do not have root privileges on.

## Usage

### Building and installing

Packages can be built and installed using the `./src/build_packages.sh` script. The following options can be set to adjust the behaviour of the script;

Option | Effect
------ | ------
Ciarán Ó Rourke's avatar
Python    
Ciarán Ó Rourke committed
13
14
15
`--skip=...` | Provide a comma-delimited list of packages to skip building (default empty; implies skip none). 
`--only=...` | Provide a comma-delimited list of packages to build exclusively (default empty; implies build all).
`--build-dependencies` | Install dependencies of primary packages. Set this option if the dependencies are not already installed on the system (not set by default).
Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
16
17
18
19
`--prefix=...` | Set the path to install packages to. This is required for systems on which you do not have root privileges.
`--python3-config-dir=...` | Provide the path to the python3 configuration directory. This is a deprecated requirement to install vim with python3 support that remains for older systems.
`-j INT` | Set the number of threads to run `make` commands with (default `1`).

Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
20
Note: only the `--skip` flag (not the `only` flag) applies to dependencies.
Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
21

Ciarán Ó Rourke's avatar
Ciarán Ó Rourke committed
22
23
24
## Updating Packages

Packages are tracked using Git subtrees. To update a package follow the steps at the [handbook page](https://git.ichec.ie/performance/ichec-handbook/-/blob/master/pages/tools/git/subtree.md).