Skip to content

Commit

Permalink
docs: add main readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ivodolenc committed Nov 18, 2024
1 parent 4667f32 commit 46d3681
Showing 1 changed file with 89 additions and 0 deletions.
89 changes: 89 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
<p align="center">
<img alt="Firefox Compact UI" src="./media/cover.png">
</p>

<h1 align="center">Firefox Compact UI</h1>

<p align="center">Minimalistic one-line user interface for Firefox Browser.</p>

<p align="center">
<a href="https://github.com/ivodolenc/firefox-compact">Repository</a>
<span>✦</span>
<a href="https://github.com/ivodolenc/firefox-compact/releases">Releases</a>
<span>✦</span>
<a href="https://github.com/ivodolenc/firefox-compact/discussions">Discussions</a>
</p>

<br>

<p align="center">
<sub>Special Sponsor</sub>
</p>

<p align="center">
<a title="Hypernym Studio" href="https://github.com/hypernym-studio">
<img alt="Hypernym Studio" width="190" src="./media/hypernym-logo.svg">
</a>
</p>

<br>

## Features

- Adds compact modern style
- Provides a more rounded look
- Allows native toolbar customization
- Supports all color themes

## Installation

1. Open the Firefox browser.

2. Type `about:config` in the address bar and open the config page.

- Search for preference name `toolkit.legacyUserProfileCustomizations.stylesheets` and set it to `true`.

3. Type `about:support` in the address bar and open the support page.

- Find the `Profile Folder` on the left and click `Show in Finder` button to open the `Profile` directory.
- Download the `chrome` directory from the latest [release](https://github.com/ivodolenc/firefox-compact/releases) and copy it to your previously opened `Profile` directory.

4. Restart Firefox to apply the `Compact UI` changes.

<sub>Read the official <a href="https://support.mozilla.org/en-US/kb/contributors-guide-firefox-advanced-customization">guide</a> to learn more about Firefox Configuration.</sub>

## Color Themes

**Firefox Compact UI** is designed to natively support all color themes.

Check out some of the themes that come with the browser below.

### Dark Theme

<p align="center">
<img alt="Dark Compact UI" src="./media/dark-theme.png">
</p>

### Light Theme

<p align="center">
<img alt="Light Compact UI" src="./media/light-theme.png">
</p>

### Alpenglow Theme

<p align="center">
<img alt="Alpenglow Compact UI" src="./media/alpenglow-theme.png">
</p>

## Community

Feel free to ask questions or share new ideas.

Use the official [discussions](https://github.com/ivodolenc/firefox-compact/discussions) to get involved.

## License

Developed in 🇭🇷 Croatia, © Ivo Dolenc.

Released under the [MIT](LICENSE.txt) license.

0 comments on commit 46d3681

Please sign in to comment.