Commit 0e2ef25f authored by Franco Fichtner's avatar Franco Fichtner

README: bring it up to speed, discourage mount/umount usage

(cherry picked from commit 7985db12)
parent 7dfcd3e2
......@@ -56,7 +56,7 @@ this target. It may require several packages to be installed. The
target will try to assist in case of failure, e.g. when a missing file
needs to be fetched from an external location.
Several OPTIONS exist to customise the package:
Several OPTIONS exist to customise the package, e.g.:
* CORE_DEPENDS: a list of required dependencies for the package
* CORE_ORIGIN: sets a FreeBSD compatible package/ports origin
......@@ -75,36 +75,21 @@ make upgrade
Upgrade will run the package build and attempt to replace the currently
installed package in the system. Safety measures may prevent the target
from succeeding. The following rules apply:
from succeeding. Instructions on how to proceed in case of failures are
given inline.
In order to install from the master branch of this repository, the
opnsense-devel package must be installed:
# pkg install opnsense-devel
In order to install from the stable branches of this repository, the
opnsense-stable package must be installed:
make lint
---------
# pkg install opnsense-stable
Run serveral syntax checks on the repository. This is recommended
before issuing a pull request on GitHub.
make mount
make style
----------
Live-mount the package into the current system. This will overlay
the repository over /usr/local and will instantly change the GUI
accordingly. In this mode changes can be quickly tested.
Note that live-mount will not be persistent after reboot and causes
trouble when used while upgrading firmware as packages get installed
into the repository as oppsed to the system. Use with care.
Run the CodeSniffer PSR2 style checks on the MVC code base.
make umount
-----------
Disable the live-mount feature.
make lint
---------
make sweep
----------
Run serveral syntax checks on the repository. This is recommended
before issuing a pull request on GitHub.
Run Linux Kernel cleanfile witespace sanitiser on all files.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment