Skip to content

Commit

Permalink
Clarification and rewording
Browse files Browse the repository at this point in the history
  • Loading branch information
CobaltBSD committed Sep 14, 2023
1 parent ad1633b commit 21ddcde
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,55 +16,52 @@ Current focus is on general improvements to the codebase, as well as fixing a nu
* Various upstream improvements and UI enhancements to Gtk frontend
* Removed compatibility for super old and/or obscure libraries/software/operating systems
* Dedicated LibreSSL support
* Various privacy improvements
* Numerous privacy improvements
* Rewritten build system
* Simplified frontend development

## Known Issues
At the moment preferences on Gtk frontend do not take effect, and as such this menu is currently disabled. This issue is inherited from NetSurf and will be amended soon.

## Building and installation
In the root of the source tree:
```sh
$ mkdir -v build
$ cd build
```

To build with both Visurf and Gtk frontends:
```sh
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
$ cmake -B build -DCMAKE_INSTALL_PREFIX=/usr
```
To build with Visurf only:
```sh
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_GTK_FRONTEND=OFF
$ cmake -B build -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_GTK_FRONTEND=OFF
```
To build with Gtk only:
```sh
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_VI_FRONTEND=OFF
$ cmake -B build -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_VI_FRONTEND=OFF
```
To build libneosurf only (no frontend):
```sh
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_GTK_FRONTEND=OFF -DNEOSURF_BUILD_VI_FRONTEND=OFF
$ cmake -B build -DCMAKE_INSTALL_PREFIX=/usr -DNEOSURF_BUILD_GTK_FRONTEND=OFF -DNEOSURF_BUILD_VI_FRONTEND=OFF
```

Then:
```sh
$ make
$ sudo make install
$ make -C build
```

And as root:
```sh
# make -C build install
```

NeoSurf is geared towards the Cobalt operating system, but is intended to remaining portable.
NeoSurf is geared towards the Cobalt operating system, but is intended to remaining portable on any Linux or BSD-based platforms.

At build-time, NeoSurf requires the following programs:
* python3
* cmake
* any CMake-compatible build utility (typically GNU make)
* a POSIX-compliant shell
* Z Shell
* gperf
* flex
* bison or byacc
* pkg-config or pkgconf
* Z Shell

At runtime and build-time, the following libraries and their development headers are required:
* libcurl
Expand Down

0 comments on commit 21ddcde

Please sign in to comment.