mirror of
https://github.com/matrix-construct/construct
synced 2024-11-25 16:22:35 +01:00
doc: Add summary to clarify document's purpose and scope. [ci skip]
This commit is contained in:
parent
7883164bce
commit
d1b125e4b7
1 changed files with 10 additions and 4 deletions
14
doc/SETUP.md
14
doc/SETUP.md
|
@ -1,9 +1,10 @@
|
||||||
## SETUP
|
## SETUP
|
||||||
|
|
||||||
- For standalone builds you will need to add the included lib directories
|
This guide will help you execute Construct for the first time. If you are
|
||||||
in your git repo to the library path:
|
building from source code and have not already done so please follow the
|
||||||
`export LD_LIBRARY_PATH=/path/to/src/deps/boost/lib:$LD_LIBRARY_PATH`
|
instructions in [BUILD](BUILD.md) before continuing here.
|
||||||
`export LD_LIBRARY_PATH=/path/to/src/deps/rocksdb:$LD_LIBRARY_PATH`
|
|
||||||
|
#### NOTES
|
||||||
|
|
||||||
- We will refer to your server as `host.tld`. For those familiar with matrix:
|
- We will refer to your server as `host.tld`. For those familiar with matrix:
|
||||||
this is your _origin_ and mxid `@user:host.tld` hostpart. If you delegate
|
this is your _origin_ and mxid `@user:host.tld` hostpart. If you delegate
|
||||||
|
@ -13,6 +14,11 @@ this as your _servername_.
|
||||||
> Construct clusters all share the same _origin_ but each individual instance
|
> Construct clusters all share the same _origin_ but each individual instance
|
||||||
of the daemon has a unique _servername_.
|
of the daemon has a unique _servername_.
|
||||||
|
|
||||||
|
- If you built construct yourself as a standalone build you will need to add
|
||||||
|
the included library directories before executing:
|
||||||
|
`export LD_LIBRARY_PATH=/path/to/src/deps/boost/lib:$LD_LIBRARY_PATH`
|
||||||
|
`export LD_LIBRARY_PATH=/path/to/src/deps/rocksdb:$LD_LIBRARY_PATH`
|
||||||
|
|
||||||
### PROCEDURE
|
### PROCEDURE
|
||||||
|
|
||||||
1. Execute
|
1. Execute
|
||||||
|
|
Loading…
Reference in a new issue