Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

89 lines (59 loc) · 1.58 KB

Contributing

License

MIT.

Versioning

Semantic Versioning.

Requirements

  • GNU make
  • Docker and docker-compose

Development

For available commands, see:

$ make help

Building

To build distributable files, run:

$ make build

Builds are created to a build directory in the project directory, which can be installed to a Firefox profile.

OpenSearch engines

Open search engines can be installed through the included server and the web page:

$ make start

You can find the web server from the address printed after running the above command.

Customization

New tab page top site thumbnails

Custom thumbnails can be added by creating a custom/sites directory and adding thumbnail images named after the site's hostname:

$ mkdir -p custom/sites
$ curl -s http://via.placeholder.com/320x180.jpg > custom/sites/google.com.jpg
$ curl -s http://via.placeholder.com/320x180.jpg > custom/sites/mozilla.org.jpg
$ make build

Custom userContent style sheets

Custom styles sheets can be created to custom/content directory and will be appended to the generated userContent.css.

Custom user.js preferences

Custom user settings file can be created to custom/user.js and it will be appended to the generated user.js.

Custom search engines

Custom OpenSearch engines can be created to custom/opensearch/engines.

Coding style

To verify that your additions follows coding style, run:

$ make lint