mirrors/mue
1
0
Fork 0
mirror of https://github.com/mue/mue.git synced 2026-06-08 22:18:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

style: md in favour of html, add automatic toc

Browse Source
This commit is contained in:
Wessel T
2021-03-27 13:32:51 +01:00
committed by GitHub
parent 456350c669
commit ea24e2653a
1 changed files with 28 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
README.md
View File

@@ -12,24 +12,7 @@ Mue is a fast, open and free-to-use browser extension that gives a new, fresh an
<br> <br>
## Table of contents ## Table of contents
* [Screenshot](#screenshot) [[toc]]
* [Features](#features)
* [Planned Features](#planned-features)
* [Installation](#installation)
* [Chrome](#chrome)
* [Firefox](#firefox)
* [Edge Chromium](#edge-chromium)
* [Naver](#naver)
* [Other](#other)
* [Contributing](#development)
* [Requirements](#requirements)
* [Starting](#starting)
* [Building](#building)
* [Credits](#credits)
* [Maintainers](#maintainers)
* [Contributors](#contributors)
* [Translators](#translators)
## Screenshot ## Screenshot
![Screenshot](assets/screenshot.jpg) ![Screenshot](assets/screenshot.jpg)
@@ -69,21 +52,17 @@ Please note that we have dropped support for Opera as of Mue 5.0
[GitHub Releases](https://github.com/mue/mue/releases) [GitHub Releases](https://github.com/mue/mue/releases)
### Development ## Development
#### Requirements #### Requirements
<ol> * [Git](https://git-scm.com/)
<li><a href='https://git-scm.com'>Git</a></li> * [Node.JS](https://nodejs.org/)
<li><a href='https://nodejs.org'>Node.JS</a></li> * A suitable browser
<li>A suitable browser</li> #### Starting
</ol> 1. Clone the repository using `git clone https://github.com/mue/mue.git`
<h5>Starting</h5> 2. Run `yarn` or `npm i` to install all needed dependencies
<ol> 3. Run `yarn start` or `npm start` to start testing
<li> Clone the repository using <code>git clone https://github.com/mue/mue.git</code> 4. Code your heart out! (See the sections below for how to build the extension)
<li> Run <code>yarn</code> or <code>npm i</code> to install all needed dependencies #### Building
<li> Run <code>yarn start</code> or <code>npm start</code> to start testing
<li> Code your heart out! (See the sections below for how to build the extension)
</ol>
<h2>Building</h2>
<details> <details>
<summary><b>Chrome/Edge (Chromium)</b> (Click to expand)</summary> <summary><b>Chrome/Edge (Chromium)</b> (Click to expand)</summary>
<ol> <ol>
@@ -128,36 +107,23 @@ Please note that we have dropped support for Opera as of Mue 5.0
</details> </details>
## Credits ## Credits
### Core Team ### Developers
#### Developers [David Ralph](https://github.com/davidjcralph) - Lead development, photographer <br/>
[David Ralph](https://github.com/davidjcralph) - Lead development, photographer <br> [Alex Sparkes](https://github.com/alexsparkes) - Name, lead design, photographer <br/>
[Isaac Saunders](https://github.com/eartharoid) - QA, development, photographer <br/>
[Alex Sparkes](https://github.com/alexsparkes) - Name, lead design, photographer <br> [Wessel Tip](https://github.com/Wessel) - Development <br/>
[Isaac Saunders](https://github.com/eartharoid) - QA, development, photographer <br>
[Wessel Tip](https://github.com/Wessel) - Development <br>
### Translators ### Translators
[Wessel Tip](https://github.com/Wessel) - Dutch [Wessel Tip](https://github.com/Wessel) - Dutch<br/>
[Alex Sparkes](https://github.com/alexsparkes), [Maxime](https://github.com/exiam) - French<br/>
[Alex Sparkes](https://github.com/alexsparkes), [Maxime](https://github.com/exiam) - French [Anders](https://github.com/FuryingFox) - Norwegian<br/>
[Pronin Egor](https://github.com/MrZillaGold) - Russian<br/>
[Anders](https://github.com/FuryingFox) - Norwegian [Vicente](https://github.com/Vicente015) - Spanish<br/>
[Austin Huang](https://github.com/austinhuang0131) - Chinese (Simplified)<br/>
[Pronin Egor](https://github.com/MrZillaGold) - Russian [FreeFun](https://github.com/xXFreeFunXx) - German<br/>
### Contributors
[Vicente](https://github.com/Vicente015) - Spanish
[Austin Huang](https://github.com/austinhuang0131) - Chinese (Simplified)
[FreeFun](https://github.com/xXFreeFunXx) - Germany
### Resources
[Pexels](https://pexels.com) - Stock photos used for offline mode
[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support
Many thanks to [Highholding](https://discord.bio/p/highholding), [Noa Shapira](#), [Roee Lupo](https://github.com/RoeeLupo), [Jeroen](#), [Glasvegas](https://twitter.com/_glasvegas), [Anders](https://github.com/FuryingFox), [Oded Shapira](https://twitter.com/dondishdev), Jacob Tyrrell and [Nikka Lai](#) for letting us use their wonderful photographs. Many thanks to [Highholding](https://discord.bio/p/highholding), [Noa Shapira](#), [Roee Lupo](https://github.com/RoeeLupo), [Jeroen](#), [Glasvegas](https://twitter.com/_glasvegas), [Anders](https://github.com/FuryingFox), [Oded Shapira](https://twitter.com/dondishdev), Jacob Tyrrell and [Nikka Lai](#) for letting us use their wonderful photographs.
And finally, a big thank you to all the [contributors](https://github.com/mue/mue/graphs/contributors)! And finally, a big thank you to all the other [contributors](https://github.com/mue/mue/graphs/contributors)!
### Resources
[Pexels](https://pexels.com) - Stock photos used for offline mode<br/>
[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support<br/>