add README with build instructions

This commit is contained in:
hippoz 2022-07-26 17:32:09 +03:00
parent 6015443679
commit c676773a44
No known key found for this signature in database
GPG key ID: 7C52899193467641

23
README.md Normal file
View file

@ -0,0 +1,23 @@
# File Manager
File Manager is a simple file manager made using Raven.
# Dependencies
- [raven](https://git.hippoz.xyz/hippoz/raven)
- librsvg
# Hacking
```
$ meson builddir
$ cd builddir
$ meson compile
```
You should now have a `filemanager` binary in the build directory.
You also need to download the folder icon SVG. You can use the Papirus one (license: GNU General Public License v3.0):
```
wget https://raw.githubusercontent.com/PapirusDevelopmentTeam/papirus-icon-theme/master/Papirus/64x64/places/folder-adwaita.svg
```