Merge pull request #1 from LVancina/build_doc_mod

Build doc mod
pull/82/head
LVancina 2023-09-10 07:00:36 -07:00 committed by GitHub
commit 538bdee201
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 7 deletions

View File

@ -6,11 +6,26 @@ To see a full list of options, run:
./waf -h
Note: if attempting to run waf as an executable as shown above results in a
message like this:
/usr/bin/env: python: No such file or directory
then try calling python directly:
python waf <args>
or
python3 waf <args>
For more background information about waf, visit the gitlab page at
https://gitlab.com/ita1024/./waf/
Configuring
-----------
To perform the configure checks, run:
To perform the configuration checks, run:
./waf configure
@ -51,6 +66,9 @@ To install, run:
This will install the compiled library and headers to wherever your prefix was
specified. (See configure flags)
This command may have to be run with root priviledges for certain prefix
directories depending on your system setup.
Uninstalling
------------

View File

@ -96,11 +96,13 @@
<orderedlist>
<listitem>
<para>Download and unpack the NORM source code tarball.</para>
<para>Download and unpack the NORM source code tarball or clone the github
repository using
<literal>git clone --recurse-submodules https://github.com/USNavalResearchLaboratory/norm.git</literal></para>
</listitem>
<listitem>
<para><literal>cd norm/unix</literal></para>
<para><literal>cd norm/makefiles</literal></para>
</listitem>
<listitem>
@ -118,7 +120,8 @@
<orderedlist>
<listitem>
<para>Download and unpack the NORM source code tarball</para>
<para>Download and unpack the NORM source code tarball or clone the
repository as described in the section above.</para>
</listitem>
<listitem>
@ -128,7 +131,7 @@
</listitem>
<listitem>
<para>Open the "<filename>norm.sln</filename>" (VC++ .Net),
<para>Inside the "<filename>norm/makefiles/win32</filename>" directory, open the "<filename>norm.sln</filename>" (VC++ .Net),
"<filename>norm.dsw</filename>" (VC++ 6.0), or
"<filename>norm.vcw</filename>" (Embedded VC++) workspace
file.</para>
@ -140,6 +143,11 @@
the "<filename>norm/win32/norm/Release</filename>" directory.</para>
</listitem>
</orderedlist>
<para>The easiest way to run these builds is with Visual Studio. If you do not already have Visual Studio installed, then it can
be downloaded for free <ulink url="https://visualstudio.microsoft.com/downloads/?cid=learn-onpage-download-cta">here</ulink>.
When you launch Visual Studio, make sure to select "Visual C++" and open the "<filename>norm.sln</filename>" file.
This should load all of the project files and allow you to right-click on any of them in the Solution Explorer on the
left side and select "build".</para>
</sect2>
</sect1>
@ -380,7 +388,7 @@
<para>A minimal example <emphasis>norm</emphasis> sender command-line
syntax is:</para>
<para><literal>norm addr &lt;addr/port&gt; sendFile
<para><literal>norm addr &lt;addr/port&gt; sendfile
&lt;fileName&gt;</literal></para>
<para>The corresponding minimal <emphasis>norm</emphasis> receiver
@ -1160,4 +1168,4 @@
use with norm</emphasis>
</para>
</appendix>
</article>
</article>