README.md 4.92 KB
Newer Older
1
![minimal logo](./pictures/logo/minimalAvatar512.png)
2

Tim Krief's avatar
Tim Krief committed
3
# Minimal, the browser extension for peace of mind
4
5
Minimal is a browser extension to experience a minimal, less attention grabbing internet experience. Internet should be a tool, not a trap.

Tristan Dhellemmes's avatar
Tristan Dhellemmes committed
6
7
You can watch the Minimal introductory video [here](https://youtu.be/Gtf9DYDtsHw)

8
9
10
11
12
Minimal is driven by core values:

- The user must actively make choices by themselves.
- A user should easily find the content they are searching for on a page, not the content a platform wants them to see.
- A service provider can convince the user to use their platform, but only through their services' inner quality.
13
14
15

[![Get the add-on](https://addons.cdn.mozilla.net/static/img/addons-buttons/AMO-button_1.png)](https://addons.mozilla.org/firefox/addon/minimal-internet-experience/)

Tim Krief's avatar
Tim Krief committed
16
To get a complete list of the changes made to the user experience by the minimal browser extension, check the [Changes page](https://minimal.aupya.org/#about_changes). Those changes are following [minimal's manifesto](MANIFESTO.md).
Tim Krief's avatar
Tim Krief committed
17

18
This extension is being developed for the greater good, it is an open source project, you can check its code and contribute.
Tim Krief's avatar
Tim Krief committed
19

20
21
22
23
24
Some details to know:
 - All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

 - This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Tim Krief's avatar
Tim Krief committed
25
 - Minimal is fully transparent about what it does once installed, being open source and well documented (see the [Changes page](https://minimal.aupya.org/#about_changes) ). Minimal has no effect on the website themeselves, minimal is an add-on that allows you to customize your experience while browsing on the internet.
26
27
28
29
30
31
32
33

 - Minimal does not collect any data.
 
 - Your browser will require you to add permissions for minimal to access hundreds of websites (most of them being the same websites but with different top level domain extensions, for instance www.example.com and www.example.fr). Most add-ons ask the permission to access to all the websites you visit. We chose to get permissions only for the website minimal supports. For your information, those permissions are necessary for minimal to be able to add the stylesheets and the scripts needed for its functioning. If this requirement frighten you, it's a good thing, you should not accept to give permissions that easily. In the case of Minimal, you should know that it is an open-source add-on, everyone is free and invited to check its source code.

# Want to contribute?

We would be more than happy to receive some more help from the community:
Tim Krief's avatar
Tim Krief committed
34

35
## As a user
36
If you spot something that you think minimal should act upon on a common website let us know by creating a ticket [here](https://gitlab.com/aupya/minimal/issues).
37

38
If you encounter any problem while using minimal, please create a new [issue](https://gitlab.com/aupya/minimal/issues).
Tim Krief's avatar
Tim Krief committed
39
40

## As a (web)designer
41
If you have ideas about what a common website should look like or act like for it to be minimal, please, add your ideas [here](https://gitlab.com/aupya/minimal/issues). 
42
Please, try to follow [minimal's manifesto](./MANIFESTO.md).
Tim Krief's avatar
Tim Krief committed
43
44

## As a (web)developer
45
This is a browser extension, if you are not familiar about how it works, [here is a guide](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions).
Tim Krief's avatar
Tim Krief committed
46

47
48
49
50
51
52
When contributing, if you make a new change, add a comment to explain it.

The comment has to fit on one line and has to follow this pattern:
1. `/* - ` 
2. The explanation of the change
3. ` - ` 
53
4. One or more code of a rule from the [manifesto](./MANIFESTO.md)
54
55
56
5. ` */`

Changes must follow at least one rule from the [manifesto](./MANIFESTO.md). Rules codes are the first letter of a main section followed by the number of the rule. Multiple codes can be specifed, separated by spaces.
57

58
59
60
61
62
Exemples of the comment pattern:

```
/* - Explaination of the change - C3 P1 */
```
63
```
64
/* - Explaination - U2 */
65
66
```

67
68
# How to build the extension?

Tim Krief's avatar
Tim Krief committed
69
Minimal uses a custom preprocessor made in C++ to generate [manifest.json](./manifest.json) and a list of the changes visible on  the [Changes page](https://minimal.aupya.org/#about_changes). To use it, a makefile is available. You can use `make deepclean` to reset everything, `make clean` to clean the packaged add-on, and `make all` or `make development` if you want to build minimal, you will get a development version. To generate a release version, you have to use `make release`. Your built add-on is then available in `./build` The development version uses different icons and name so that it easy when developing to know if you are still using an official build or your own build. Bonus: `make test` will try to open the debugging tab of firefox so that it's easier to add your build to your browser and test it.