Skip to content

Commit

Permalink
Update build.md
Browse files Browse the repository at this point in the history
Removing unnecessary line breaks
  • Loading branch information
hjain-perforce authored May 22, 2023
1 parent 2516759 commit 0432fa3
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,36 @@


1. Download the Perforce C++ API from the Perforce FTP site at
<ftp://ftp.perforce.com/perforce>. \
<ftp://ftp.perforce.com/perforce> . \
The API archive is located in release and platform-specific subdirectories and is named
*"p4api-glibc2.3-openssl1.1.1.tgz".<br>*
*"p4api-glibc2.3-openssl1.1.1.tgz".*

**Note: 32-bit builds of P4Ruby require a 32-bit version of the C++ API and a 32-bit version of Ruby.\
           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.<br>**
Unzip the archive into an empty directory.<br>
           64-bit builds of P4Ruby require a 64-bit version of the C++ API and a 64-bit version of Ruby.**

Unzip the archive into an empty directory.

2. Extract the P4Ruby API archive into a new, empty directory.<br>
2. Extract the P4Ruby API archive into a new, empty directory.

3. Execute the build commands:<br>
3. Execute the build commands:

*bundle install \
bundle exec rake compile -- --with-p4api_dir=<absolute path to Perforce C++ API> \
           --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API><br>*
           --with-ssl-dir=<absolute path to OpenSSL libraries matching Perforce C++ API>*

OR pass through environment variables\
*bundle exec rake compile p4api_dir=<*absolute path to Perforce C++ API*><br>*
*bundle exec rake compile p4api_dir=<absolute path to Perforce C++ API>*

**Note: If the --p4api_dir flag is not provided, P4Ruby will attempt\
to download and extract correct version of Perforce C++ API<br>**
**Note: If the --p4api_dir flag is not provided, P4Ruby will attempt
to download and extract correct version of Perforce C++ API**

4. Test your distribution.<br>
4. Test your distribution.

*bundle exec rake test<br>*
*bundle exec rake test*

Tests require the perforce server binary (p4d) present in the path.<br>
Tests require the perforce server binary (p4d) present in the path.

5. Install P4Ruby into your local gem cache:<br>
5. Install P4Ruby into your local gem cache:

*bundle exec rake install*

Expand Down

0 comments on commit 0432fa3

Please sign in to comment.