Files
rippled/md____w_rippled_rippled_docs_build_environment.html
2023-04-27 17:23:28 +00:00

113 lines
5.9 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: environment</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">environment </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Our ../../BUILD.md "build instructions" assume you have a C++ development environment complete with Git, Python, Conan, CMake, and a C++ compiler. This document exists to help readers set one up on any of the Big Three platforms: Linux, macOS, or Windows.</p>
<h2><a class="anchor" id="autotoc_md36"></a>
Linux</h2>
<p>Package ecosystems vary across Linux distributions, so there is no one set of instructions that will work for every Linux user. These instructions are written for Ubuntu 22.04. They are largely copied from the <a href="https://github.com/thejohnfreeman/rippled-docker/blob/master/ubuntu-22.04/install.sh">script</a> used to configure our Docker container for continuous integration. That script handles many more responsibilities. These instructions are just the bare minimum to build one configuration of rippled. You can check that codebase for other Linux distributions and versions. If you cannot find yours there, then we hope that these instructions can at least guide you in the right direction.</p>
<div class="fragment"><div class="line">apt update</div>
<div class="line">apt install --yes curl git libssl-dev python3.10-dev python3-pip make g++-11</div>
<div class="line"> </div>
<div class="line">curl --location --remote-name \</div>
<div class="line"> &quot;https://github.com/Kitware/CMake/releases/download/v3.25.1/cmake-3.25.1.tar.gz&quot;</div>
<div class="line">tar -xzf cmake-3.25.1.tar.gz</div>
<div class="line">rm cmake-3.25.1.tar.gz</div>
<div class="line">cd cmake-3.25.1</div>
<div class="line">./bootstrap --parallel=$(nproc)</div>
<div class="line">make --jobs $(nproc)</div>
<div class="line">make install</div>
<div class="line">cd ..</div>
<div class="line"> </div>
<div class="line">pip3 install &#39;conan&lt;2&#39;</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md37"></a>
macOS</h2>
<p>Open a Terminal and enter the below command to bring up a dialog to install the command line developer tools. Once it is finished, this command should return a version greater than the minimum required (see ../../BUILD.md "BUILD.md").</p>
<div class="fragment"><div class="line">clang --version</div>
</div><!-- fragment --><p>The command line developer tools should include Git too:</p>
<div class="fragment"><div class="line">git --version</div>
</div><!-- fragment --><p>Install <a href="https://brew.sh/">Homebrew</a>, use it to install <a href="https://github.com/pyenv/pyenv">pyenv</a>, use it to install Python, and use it to install Conan:</p>
<div class="fragment"><div class="line">/bin/bash -c &quot;$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)&quot;</div>
<div class="line">brew update</div>
<div class="line">brew install xz</div>
<div class="line">brew install pyenv</div>
<div class="line">pyenv install 3.10-dev</div>
<div class="line">pyenv global 3.10-dev</div>
<div class="line">eval &quot;$(pyenv init -)&quot;</div>
<div class="line">pip install &#39;conan&lt;2&#39;</div>
</div><!-- fragment --><p>Install CMake with Homebrew too:</p>
<div class="fragment"><div class="line">brew install cmake</div>
</div><!-- fragment --> </div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>