Update readme
Signed-off-by: Vasiliy Doylov <nekocwd@mainlining.org>
This commit is contained in:
parent
d8479ef629
commit
3a220a2f25
7 changed files with 45 additions and 36 deletions
83
README.md
83
README.md
|
@ -1,27 +1,53 @@
|
|||
# phosh-vala-plugins
|
||||
# Beautiful media player for Phosh
|
||||
|
||||
Extra phosh plugins written in Vala
|
||||
Yep, it's written in Vala
|
||||
|
||||
## License
|
||||
## Galery
|
||||
|
||||
phosh-vala-plugins are licensed under the GPL-3.0-or-later licence.
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<img src="assets/shot-1.png" width="300px" alt="Home Screen" /><br/>
|
||||
<sub><b>Lock screen 1</b></sub>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="assets/shot-4.png" width="300px" alt="Settings" /><br/>
|
||||
<sub><b>Lock screen 2</b></sub>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="assets/shot-6.png" width="300px" alt="Profile" /><br/>
|
||||
<sub><b>Lock screen 3</b></sub>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center">
|
||||
<img src="assets/shot-2.png" width="300px" alt="Dashboard" /><br/>
|
||||
<sub><b>Quick settings 1</b></sub>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="assets/shot-3.png" width="300px" alt="Notifications" /><br/>
|
||||
<sub><b>Quick settings 2</b></sub>
|
||||
</td>
|
||||
<td align="center">
|
||||
<img src="assets/shot-5.png" width="300px" alt="Help" /><br/>
|
||||
<sub><b>Quick settings 1</b></sub>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
## Getting the source
|
||||
|
||||
```sh
|
||||
git clone https://gitlab.gnome.org/guidog/phosh-vala-plugins
|
||||
cd phosh-vala-plugins
|
||||
## Installing from my nightly repo
|
||||
1) [Add my nightly repo](https://git.nekocwd.duckdns.org/Administration/Documentation/src/branch/master/install-nightly-repo.md)
|
||||
2) Install plugin
|
||||
```
|
||||
|
||||
The [main][] branch has the current development version.
|
||||
|
||||
## Dependencies
|
||||
|
||||
On a Debian based system run
|
||||
|
||||
```sh
|
||||
sudo apt-get -y install build-essential meson valac libphosh-0.45-dev
|
||||
sudo apk add phosh-plugin-mediaplayer@nightly
|
||||
```
|
||||
3) Enable plugin for quick settings and/or for lockscreen
|
||||
|
||||
## Enabling plugin
|
||||
|
||||
You can enable it via gsettings `sm.puri.phosh.plugins` -> `lock-screen` or `quick-settings`
|
||||
|
||||
Or you can use `phosh-mobile-settings` app
|
||||
|
||||
## Building
|
||||
|
||||
|
@ -30,26 +56,9 @@ quickest way to get going is to do the following:
|
|||
|
||||
```sh
|
||||
meson setup _build
|
||||
meson compile -C _build
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
### Running from the source tree
|
||||
|
||||
As the plugins need to be found by phosh the simplest way is to
|
||||
install them:
|
||||
|
||||
```sh
|
||||
meson install -C _build
|
||||
```
|
||||
|
||||
Afterwards you enable the plugin via the `sm.puri.phosh.plugins`
|
||||
`lock-screen` or `quick-settings` gsetting.
|
||||
## License
|
||||
|
||||
## Getting in Touch
|
||||
|
||||
* Issue tracker: <https://gitlab.gnome.org/guidog/phosh-vala-plugins>
|
||||
* Matrix: <https://matrix.to/#/#phosh:sigxcpu.org>
|
||||
|
||||
[main]: https://gitlab.gnome.org/guido/phosh-vala-plugins
|
||||
phosh-media-player are licensed under the GPL-3.0-or-later licence.
|
||||
|
|
BIN
assets/shot-1.png
Normal file
BIN
assets/shot-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 372 KiB |
BIN
assets/shot-2.png
Normal file
BIN
assets/shot-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 268 KiB |
BIN
assets/shot-3.png
Normal file
BIN
assets/shot-3.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 367 KiB |
BIN
assets/shot-4.png
Normal file
BIN
assets/shot-4.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 472 KiB |
BIN
assets/shot-5.png
Normal file
BIN
assets/shot-5.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 362 KiB |
BIN
assets/shot-6.png
Normal file
BIN
assets/shot-6.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 460 KiB |
Loading…
Add table
Add a link
Reference in a new issue