Yoda/README.md

70 lines
1.2 KiB
Markdown
Raw Normal View History

2024-08-05 06:50:58 +03:00
# Yoda - Browser for [Gemini protocol](https://geminiprotocol.net)
2024-08-04 19:50:29 +03:00
GTK 4 / C++ implementation branch
2024-08-04 17:31:41 +03:00
> [!IMPORTANT]
> Project in development!
>
2024-08-07 07:35:53 +03:00
## Build
2024-08-07 07:30:46 +03:00
2024-08-07 07:35:53 +03:00
### Linux
2024-08-04 17:31:41 +03:00
2024-08-11 12:35:57 +03:00
``` bash
2024-08-11 15:02:34 +03:00
apt install git\
2024-08-15 12:29:54 +03:00
libglib2.0-dev\
2024-08-11 15:02:34 +03:00
libglibmm-2.68-dev\
2024-08-15 12:29:54 +03:00
libgtkmm-4.0-dev\
2024-08-20 15:38:35 +03:00
libpangomm-2.48-dev\
2024-08-11 15:01:47 +03:00
libsqlite3-dev
2024-08-11 12:35:57 +03:00
```
2024-08-04 17:31:41 +03:00
* `git clone https://github.com/YGGverse/Yoda.git`
* `cd Yoda`
* `git checkout master`
2024-08-07 07:30:46 +03:00
* `make`
2024-08-07 07:35:53 +03:00
#### Update
2024-08-07 07:30:46 +03:00
* `git pull`
* `make clean`
* `make`
2024-08-10 08:37:52 +03:00
## Localization
### Official
* [Crowdin](https://crowdin.com/project/yoda-browser)
### Personal
2024-08-11 15:01:47 +03:00
* `apt install intltool`
2024-08-10 08:37:52 +03:00
* `cd po`
* `intltool-update --pot`
2024-08-07 07:30:46 +03:00
## Development
### Environment
2024-08-11 12:35:57 +03:00
``` bash
2024-08-15 12:29:54 +03:00
pkg-config --cflags --libs gio-2.0\
2024-08-11 15:02:34 +03:00
glibmm-2.68\
2024-08-15 12:29:54 +03:00
gtkmm-4.0\
2024-08-20 15:38:35 +03:00
pangomm-2.48\
2024-08-11 15:01:47 +03:00
sqlite3
2024-08-11 12:35:57 +03:00
```
2024-08-07 07:30:46 +03:00
### Contribution
* `cd Yoda`
* `git checkout master`
2024-08-07 07:39:06 +03:00
* `git pull`
2024-08-10 08:52:44 +03:00
* `git checkout -b 'contribution-name'`
### Documentation
2024-08-10 08:56:57 +03:00
#### Components
2024-08-11 14:59:00 +03:00
* [GTK](https://gtk.org) - free and open-source cross-platform widget toolkit
* [gtkmm](https://gtkmm.org) - official C++ interface for GTK
* [SQLite](https://sqlite.org) - profile database