MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-11-25 08:12:37 +01:00
Code Issues Releases Wiki Activity

doc: Move top-level build section to doc/BUILD. [skip ci]

Browse source
This commit is contained in:
Jason Volk 2019-06-21 17:26:15 -07:00
parent 26461c0950
commit f50df0df3e
2 changed files with 58 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
README.md
View file

@ -85,73 +85,16 @@ autoconf-archive, libtool.
-->
### Getting Started
### DOWNLOAD
At this phase of development the best thing to do is pull the master branch
1. At this phase of development the best thing to do is pull the master branch
and use the latest head.
> The head of the `master` branch is consistent and should be safe to pull
without checking out a release tag. When encountering a problem with the latest
head on `master` that is when a release tag should be sought.
2. See the [BUILD](doc/BUILD.md) instructions to compile Construct from source.
### BUILD
3. See the [SETUP](doc/SETUP.md) instructions to run Construct for the first time.
*Please follow the standalone build instructions in the next section until this
notice is removed.*
```
./autogen.sh
./configure
make
sudo make install
```
### BUILD (standalone)
This section is intended to allow building with dependencies that have not
made their way to mainstream systems. Important notes that may affect you:
- GCC: Ubuntu Xenial (16.04) users must use a PPA to obtain GCC-7 or greater; don't
forget to `export CXX=g++-7` before running `./configure` on that system.
- Boost: The required version is available through `apt` as `boost-all-dev` on
Ubuntu Cosmic (18.10). All earlier releases (including 18.04 LTS) can configure
with `--with-included-boost` as instructed below.
- RocksDB: The required version is available through `apt` as `librocksdb-dev` on
Ubuntu Disco (19.04). All earlier releases (including 18.04 LTS) can configure
with `--with-included-rocksdb` as instructed below.
#### STANDALONE BUILD PROCEDURE
```
./autogen.sh
mkdir build
```
> The install directory may be this or another place of your choosing. If you decide
elsewhere, make sure to change the `--prefix` in the `./configure` statement below.
```
./configure --prefix=$PWD/build --with-included-boost --with-included-rocksdb
```
> The `--with-included-*` will fetch, configure **and build** the dependencies included
as submodules.
```
make install
```
Additional documentation for building can be found in the [BUILD](doc/BUILD.md)
addendum.
### SETUP
See the [SETUP](doc/SETUP.md) instructions to run Construct for the first time.
### TROUBLESHOOTING
##### TROUBLESHOOTING
See the [TROUBLESHOOTING](doc/TROUBLESHOOTING.md) guide for solutions to possible
problems.

53
doc/BUILD.md
View file

@ -1,3 +1,56 @@
## BUILD
*Most users will need follow the standalone build instructions in the next section.*
```
./autogen.sh
./configure
make
sudo make install
```
### BUILD (standalone)
This section is intended to allow building with dependencies that have not
made their way to mainstream systems. Important notes that may affect you:
- GCC: Ubuntu Xenial (16.04) users must use a PPA to obtain GCC-7 or greater; don't
forget to `export CXX=g++-7` before running `./configure` on that system.
- Boost: The required version is available through `apt` as `boost-all-dev` on
Ubuntu Cosmic (18.10). All earlier releases (including 18.04 LTS) can configure
with `--with-included-boost` as instructed below.
- ~~RocksDB: The required version is available through `apt` as `librocksdb-dev` on
Ubuntu Disco (19.04). All earlier releases (including 18.04 LTS) can configure
with `--with-included-rocksdb` as instructed below.~~
- RocksDB: At this time we advise **all users** including those on 19.04 to
configure with `--with-included-rocksdb` until regressions in your RocksDB
package have been fixed.
#### STANDALONE BUILD PROCEDURE
```
./autogen.sh
mkdir build
```
> The install directory may be this or another place of your choosing. If you decide
elsewhere, make sure to change the `--prefix` in the `./configure` statement below.
```
./configure --prefix=$PWD/build --with-included-boost --with-included-rocksdb
```
> The `--with-included-*` will fetch, configure **and build** the dependencies included
as submodules.
```
make install
```
## Installation Addendum
#### Additional build options