mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 02:11:55 +00:00
aed86e7e6c
* re-arrange the user docs * Minor description edit * update styles * fix service links Co-authored-by: kn0wmad <kn0wmad@protonmail.com> Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
29 lines
897 B
ReStructuredText
29 lines
897 B
ReStructuredText
.. _service_makefile:
|
|
|
|
========
|
|
Makefile
|
|
========
|
|
|
|
.. note:: *This file is optional*
|
|
|
|
A Makefile serves as a convenience for outlining the build. This helps streamline additional developer contributions to the project. Please reference the GNU `documentation <https://www.gnu.org/software/make/manual/html_node/Introduction.html>`_ for implementation details.
|
|
|
|
An alternative to using ``make`` is to use the `nix <https://nixos.wiki/wiki/Nix>`_ specification.
|
|
|
|
This purpose of this file is to:
|
|
|
|
- Read the docker container and build the project
|
|
- Build all prerequisites for running the docker file
|
|
- Build all dependencies
|
|
- Package assets and docker image using ``embassy-sdk pack``
|
|
|
|
Example
|
|
-------
|
|
|
|
The `LND wrapper <https://github.com/Start9Labs/lnd-wrapper/blob/master/Makefile>`_ features a well defined Makefile, for example.
|
|
|
|
.. role:: raw-html(raw)
|
|
:format: html
|
|
|
|
:raw-html:`<br />`
|