Files
mue/README.md
2019-01-19 13:55:24 +00:00

106 lines
3.9 KiB
Markdown

# Mue
<a href='https://ko-fi.com/ohlookitsderpy' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://vgy.me/u7sGQr.png' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
<a href='https://patreon.com/ohlookitsderpy' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://vgy.me/PKn6Z8.png' border='0' alt='Become a patron on patreon.com' /></a>
Fast, open and free-to-use new tab page for most modern browsers
## Features
* Fast and free
* Supports multiple browsers
* Actively developed and opensource
* Multiple language support
## Installation
### Chrome
<a href='https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid'><img src='https://vgy.me/h6SLKn.png' target='_blank'></a>
Link: https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid
Development: Read the [Development](#development) section
### Opera
Development: Read the [Development](#development) section
### Firefox
<a href='https://addons.mozilla.org/firefox/addon/mue/'><img src='https://vgy.me/REe6qz.png' target='_blank'></a>
Link: https://addons.mozilla.org/firefox/addon/mue/
Development: Read the [Development](#development) section
### Development
<h5>Starting</h5>
<ol>
<li> <code>git clone https://github.com/ohlookitsderpy/Mue</code> (If you don't have Git just go to <b>Clone or
download</b> and click <b>Download ZIP</b>)
<li> <code>yarn</code> (or <code>npm install</code>)
<li> <code>yarn run sass-watch</code> (or <code>npm run sass-watch</code>)
<li>Start developing! (See the sections below for how to set it up with your browser)
</ol>
<details>
<summary><b>Chrome</b> (Click to expand)</summary>
<ol>
<li> Rename <code>manifest-chrome.json</code> to <code>manifest.json</code>
<li> Visit <code>chrome://extensions</code> in Chrome
<li> Click <b>Load unpacked</b> (Make sure <b>Developer Mode</b> is on)
<li> Go to the directory containing Mue and click <b>ok</b>
<li> Enjoy your new tab!
</details>
<details>
<summary><b>Opera</b> (Click to expand)</summary>
<ol>
<li> Rename <code>manifest-opera.json</code> to <code>manifest.json</code>
<li> Visit <code>about://extensions</code> in Opera
<li> Click <b>Load unpacked extension...</b> (Make sure <b>Developer Mode</b> is on)
<li> Go to the directory containing Mue and click <b>ok</b>
<li> Enjoy your new tab!
</details>
<details>
<summary><b>Firefox</b> (Click to expand)</summary>
<i>Note: I'm currently trying to find a better method to do this, but this works for now. Also in testing and may not
work properly!</i>
<ol>
<li> Rename <code>manifest-firefox.json</code> to <code>manifest.json</code>
<li> Visit <code>about:debugging#addons</code> in Firefox
<li> Click <b>Load Temporary Add-on</b>
<li> Go to the directory containing Mue and click on the <b>manifest.json</b>
<li> Enjoy your new tab!
</details>
<details>
<summary><b>Other</b> (Click to expand)</summary>
<i>Note: To get the full new tab experience, just set your browser to open the index.html on startup and tab open
<ol>
<li> Open the index.html in your browser
<li> Enjoy your new tab!
</ol>
</details>
## Screenshot
*Will be updated if needed*
<img src='https://vgy.me/K8T5EP.png'>
## Translations
English - Quotes and Messages
Italian - Quotes and Messages
Spanish - Quotes and Messages
Portuguese - Quotes (Some)
Dutch - Messages
French - Messages
*Feel free to pull request with other translations!*
## Credits
[Turbomarshmello](https://github.com/TurboMarshmello) - Portions of original code, name idea.
[Pexels](https://pexels.com) - Stock photos used
[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support
[Animate.css](https://daneden.github.io/animate.css/) - Portions of code used for animations
and all the contributors <3