summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9eed5d5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+[//]: # ( SPDX-License-Identifier: CC0-1.0 )
+
+[//]: # ( Haketilo's README file )
+
+[//]: # ( Copyright (C) 2021 Wojtek Kosior )
+
+[//]: # ( Available under the terms of Creative Commons Zero v1.0 Universal. )
+
+# Haketilo - Make The Web Great Again!
+
+This extension's goal is to allow replacing javascript served by websites
+with scripts specified by user. Something like NoScript and Greasemonkey
+together. Such facility is necessary to enable browsing World Wide Web
+without executing nonfree software.
+
+Currently, the target browsers for this extension are Ungoogled Chromium
+and various forks of Firefox (version 60+).
+
+This extension is still in an early stage. Also see
+[our wiki](https://hydrillabugs.koszko.org/projects/haketilo/wiki/)
+for documentation in development.
+
+## Installation
+The extension can be "built" with `./build.sh mozilla` or `./build.sh chromium`.
+This creates directories build_mozilla/ and build_chromium/, respectively.
+Such directory can be loaded into Ungoogled Chromium or a modern Gecko-based
+browser as unpacked extension.
+
+## Copyright
+All copyright information is gathered in the `copyright` file which follows
+(loosely) the [format of debian/copyright file](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/). License notices are also present in all text files of the extension.
+
+In general, this entire extension is available under the terms of GPLv3+ with
+various additional licenses and permissions for particular files.
+
+I, Wojtek Kosior, thereby promise not to sue for violation of this program's
+licenses. Although I request that you do not make use this code in a proprietary
+program, I am not going to enforce this in court.
+
+## Contributing
+Get the code from: https://git.koszko.org/browser-extension/
+Come to: https://hydrillabugs.koszko.org/projects/haketilo
+
+Optionally, write to `$(echo a29zemtvQGtvc3prby5vcmcK | base64 -d)`