diff options
| author | Vincent Sanders <vince@kyllikki.org> | 2020-01-21 20:55:34 +0000 |
|---|---|---|
| committer | Vincent Sanders <vince@kyllikki.org> | 2020-01-21 20:55:34 +0000 |
| commit | c543e3c61c5c7a028abc2a851a818a10ea619069 (patch) | |
| tree | 67c68d97e03bcf8c260c5e93066cd6f8cca2a6b5 /docs | |
| parent | 23d9f7040de5c603512c8b279c20364a53f81df7 (diff) | |
| download | netsurf-c543e3c61c5c7a028abc2a851a818a10ea619069.tar.gz netsurf-c543e3c61c5c7a028abc2a851a818a10ea619069.tar.bz2 | |
update quick build instructions to include notes on env script
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development.md | 2 | ||||
| -rw-r--r-- | docs/mainpage.md | 13 | ||||
| -rw-r--r-- | docs/quick-start.md | 13 | ||||
| -rw-r--r-- | docs/user-interface.md | 2 |
4 files changed, 25 insertions, 5 deletions
diff --git a/docs/development.md b/docs/development.md index 773cf6b8f..c9268d4d4 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,6 +1,8 @@ Development =========== +[TOC] + # Working with the team Generally it is sensible to check with the other developers if you are diff --git a/docs/mainpage.md b/docs/mainpage.md index de5de7331..afff4b65d 100644 --- a/docs/mainpage.md +++ b/docs/mainpage.md @@ -1,8 +1,13 @@ NetSurf web browser =================== -[*](https://bestpractices.coreinfrastructure.org/projects/1037) + -# [Project](docs/project.md) -# [User Interface](docs/user-interface.md) -# [Development](docs/development.md) +[CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1037) + + +[Project](docs/project.md) + +[User Interface](docs/user-interface.md) + +[Development](docs/development.md)
\ No newline at end of file diff --git a/docs/quick-start.md b/docs/quick-start.md index 601269c96..126b26a09 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -1,10 +1,21 @@ Quick Build Steps for NetSurf ============================= -Last Updated: 15th December 2017 +Last Updated: 21st January 2020 This document provides steps for building NetSurf. +These instructions use a shell script to perform several operations. +This script has only been tested with the bash and zsh bourne style +shell interpreters. The latest version of this script should be +retrieved from the official NetSurf source repository. + +This shell script is used by the NetSurf Developers but you should +satisfy yourself that the script is not malicious. It should be noted +that the building the browser will also be executing shell code and +requires a similar level of trust. + + Native build ============ diff --git a/docs/user-interface.md b/docs/user-interface.md index 5d7673f71..36b0103a9 100644 --- a/docs/user-interface.md +++ b/docs/user-interface.md @@ -1,6 +1,8 @@ User Interface ============== +[TOC] + Netsurf is divided into a series of frontends which provide a user interface around common core functionality. Each frontend is a distinct implementation for a specific GUI toolkit. |