mirrors
/
netsurf
mirror of https://github.com/netsurf-browser/netsurf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve quick start documentation to match current reality

This commit is contained in:
Vincent Sanders 2018-05-10 13:34:33 +01:00
parent 2290c208ba
commit 1b892391d7
1 changed files with 27 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/quick-start.md
View File

@ -1,15 +1,18 @@
Quick Build Steps for NetSurf
=============================
Last Updated: 24 February 2015
Last Updated: 15th December 2017
This document provides steps for building NetSurf.
Native build
============
Grab a temporary env.sh
-----------------------
$ wget http://git.netsurf-browser.org/netsurf.git/plain/docs/env.sh
$ unset HOST
$ source env.sh
@ -28,6 +31,11 @@ If your package manager is not supported, you will have to install third
Get the NetSurf project source code from Git
--------------------------------------------
All the sources for the browser and support libraries is available
from the public git server.
Local copies may be easily obtained with the ns-clone command.
$ ns-clone
@ -42,7 +50,7 @@ Updates NetSurf project library sources to latest, builds and installs them.
Switch to new NetSurf workspace
-------------------------------
Remove the bootstrack script and use the newly installed one
Remove the bootstrap script and use the newly installed one
$ rm env.sh
$ cd ~/dev-netsurf/workspace
@ -54,8 +62,8 @@ Build and run NetSurf
$ cd netsurf
To build the native front end (the GTK front end on Linux, BSDs, etc) you
could do:
To build the native front end (the GTK front end on Linux, BSDs, etc)
you could do:
$ make
$ ./nsgtk
@ -70,23 +78,23 @@ Cross Compiling
===============
If you are cross compiling, you can follow the above steps, but when
sourcing env.sh, you should set HOST environment variable to the
appropriate triplet for your cross compiler. For example, to cross
compile for RISC OS:
sourcing env.sh, you should set HOST environment variable to the
appropriate triplet for your cross compiler. For example, to cross
compile for RISC OS:
$ HOST=arm-unknown-riscos source env.sh
After that, the commands such as `ns-package-install` and
`ns-pull-install` will do what is appropriate for the platform you
are building for.
`ns-pull-install` will do what is appropriate for the platform you are
building for.
To do the final build of NetSurf, pass the appropriate TARGET to make.
For example, to cross compile for RISC OS:
To do the final build of NetSurf, pass the appropriate TARGET to
make. For example, to cross compile for RISC OS:
$ make TARGET=riscos
Finally, you can package up your build to transfer to the system you
are developing for. For example, to produce a package for RISC OS:
are developing for. For example, to produce a package for RISC OS:
$ make TARGET=riscos package
@ -94,18 +102,19 @@ Getting a cross compiler set up
-------------------------------
We maintain cross compilation environments and an SDK for a number of
platforms. These may be found in our toolchains repository.
platforms. These may be found in our toolchains repository.
$ git clone git://git.netsurf-browser.org/toolchains
Pre-built versions of the toolchains for Debian systems are often available
via our [automated build and test infrastructure](http://ci.netsurf-browser.org/builds/toolchains/)
Pre-built versions of the toolchains for 64bit x86 Debian systems are
available via our [automated build and test
infrastructure](http://ci.netsurf-browser.org/builds/toolchains/)
Not working?
============
If the above steps are inapplicable, or don't work, you can build manually.
Follow the instructions in the BUILDING-* documents in the docs/ directory
the NetSurf browser source tree.
If the above steps are inapplicable, or don't work, you can build
manually. Follow the instructions in the BUILDING-* documents in the
docs/ directory the NetSurf browser source tree.