aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBeatLink <beatlink@protonmail.com>2019-08-16 22:00:32 -0500
committerBeatLink <beatlink@protonmail.com>2019-08-16 22:00:32 -0500
commit088d2f7727fd1c88b75bec370d9131e0bbd1e432 (patch)
tree32bf0a9bcccfd7b47478fdd3b48e235021f83700 /README.md
parentMove other platforms to own repo (diff)
downloadlibrewolf-linux-088d2f7727fd1c88b75bec370d9131e0bbd1e432.tar.gz
librewolf-linux-088d2f7727fd1c88b75bec370d9131e0bbd1e432.tar.bz2
librewolf-linux-088d2f7727fd1c88b75bec370d9131e0bbd1e432.zip
move linux files to top level
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 11 insertions, 25 deletions
diff --git a/README.md b/README.md
index 867f5f8..92458b0 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,14 @@
-![Logo](https://gitlab.com/librewolf-community/librewolf/raw/master/branding/logo/Logo.svg)
+This Repository contains all the required material to build the browser on Linux platforms.
-# LibreWolf: Browse With Freedom
-[![Download Badge](https://img.shields.io/badge/Download-purple.svg)](https://gitlab.com/librewolf-community/librewolf/releases)
-[![Website Badge](https://img.shields.io/badge/Website-librewolf--community.gitlab.io-blue.svg)](https://LibreWolf-Community.gitlab.io)
-[![Chat Badge](https://img.shields.io/badge/Chat-Gitter-blue.svg)](https://gitter.im/librewolf-community/librewolf)
-[![Status Badge](https://img.shields.io/badge/Status-Active_Development-brightgreen.svg)](https://gitlab.com/librewolf-community/librewolf/commits/master)
-[![Pipelines Badge](https://gitlab.com/librewolf-community/librewolf/badges/master/pipeline.svg)](https://gitlab.com/librewolf-community/librewolf/pipelines)
-
-This project is an independent fork of Firefox, with the primary goals of privacy security and user freedom. It is the community run successor to [LibreFox](https://github.com/intika/Librefox)
-
-## [Documentation](https://librewolf-community.gitlab.io/docs)
-
-https://librewolf-community.gitlab.io/docs
-
-The docs are built from the [LibreWolf docs repo](https://gitlab.com/librewolf-community/librewolf-docs).
-
-## [Website](https://librewolf-community.gitlab.io)
-
-https://librewolf-community.gitlab.io
-
-The website is built from the [`librewolf-community.gitlab.io` repo](https://gitlab.com/librewolf-community/librewolf-community.gitlab.io). [Hugo](https://gohugo.io) is used to generate the site.
-
-## Browser Files
-This folder contains platform specific subfolders which houses the scripts and files required to compile LibreWolf on various platforms such as Linux, Windows, Mac and android.
-All of the platforms are self explanatory with the exception of common. Common stores files common to all platforms, mainly our custom branding to be applied to the source code.
+### Requirements
+* Ubuntu or Linux Mint (Bionic or later)
+### Notes
+* As this script installs files during the build, it is recommended to run this script in a VM or installation dedicated to building.
+* You will occassionally need to enter your sudo password. Running this script as root has not been tested
+* This script has been tested with Linux Mint 19.1
+* The flatpak build is not ready yet.
+### Instructions
+* Run build.sh inside this folder.
+* Packages will be saved in the repository root folder.
bgstack15