Skip to content

Commit 1184148

Browse files
committed
dev: Updated README
1 parent 749d34f commit 1184148

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@ used in batch mode to execute commands from files.
2121

2222
## Installation
2323

24-
Autoconf is used to take care of platform dependent locations. It is mainly inherited from the Pacemaker source.
24+
The GNU Autotools suite is used to configure the OCF root directory,
25+
the Asciidoc tool which is used to generate documentation and the
26+
default daemon user (usually hacluster).
27+
28+
It then calls the python setuptools setup.py to actually process the
29+
Python module sources and install into the Python system site-packages
30+
directory.
2531

2632
```shell
2733
./autogen.sh
@@ -52,6 +58,14 @@ version, install git and run this command:
5258
git clone https://github.com/ClusterLabs/crmsh
5359
```
5460

61+
There is a git `pre-commit` hook used to update the data-manifest
62+
which lists all the data files to be installed. To install this, run
63+
64+
```shell
65+
cp contrib/git-hook-pre-commit .git/hooks/pre-commit
66+
chmod +x .git/hooks/pre-commit
67+
```
68+
5569
## Community
5670

5771
* Bugs and issues can be reported at the [crmsh issues @ Github.com](https://github.com/clusterlabs/crmsh/issues) page.

0 commit comments

Comments
 (0)