Merge branch 'master' of https://github.com/sunglocto/pi-im
This commit is contained in:
29
README.md
29
README.md
@@ -13,7 +13,7 @@ Experimental and extremely weird XMPP client written in Go. No solicitors.
|
||||
|
||||
pi is currently pre-pre-pre-pre alpha software which you should not use as your primary XMPP client.
|
||||
|
||||
pi uses [Fyne](https://fyne.io) for the frontend and uses the [Oasis SDK](https://github.com/jjj333-p/oasis-sdk) for XMPP functionality.
|
||||
pi uses [Fyne](https://fyne.io) for the frontend and uses the [Oasis SDK](https://github.com/jjj333-p/oasis-sdk) by [Joseph Winkie](https://pain.agency) for XMPP functionality.
|
||||
|
||||
pi is an extremely opinionated client. It aims to have as little extra windows as possible, instead using alt-menus to perform many of the actions you'd see in a typical client.
|
||||
|
||||
@@ -38,12 +38,19 @@ If you want to add MUCs or DMs, you must configure the program by editing the pi
|
||||
<MucsToJoin>room2@muc.example.com</MucsToJoin>
|
||||
</Login>
|
||||
<Notifications>true</Notifications>
|
||||
<DMs>person1@example.com</DMs>
|
||||
</piConfig>
|
||||
```
|
||||
|
||||
The file is usually located at, on GNU/Linux systems:
|
||||
```
|
||||
~/.config/fyne/pi-im/Documents/pi.xml
|
||||
```
|
||||
This will be changed eventually, likely before a 3b release.
|
||||
|
||||
Currently joining and saving DM tabs is not supported, nor is getting avatars, reactions or encryption.
|
||||
|
||||
As of writing, pi supports basic message sending and receiving, replies and ~~file upload~~.
|
||||
As of writing, pi supports basic message sending and receiving, replies, file upload and corrections.
|
||||
|
||||
|
||||
## να χτίσω
|
||||
@@ -51,23 +58,27 @@ As of writing, pi supports basic message sending and receiving, replies and ~~fi
|
||||
|
||||
To build pi, you will need the latest version of Go, at least 1.21. You can grab it [here](https://go.dev).
|
||||
|
||||
The build instructions are very simple. Simply clone the repo, fetch the repositories and build the program:
|
||||
The build instructions are very simple. Simply clone the repo, fetch the repositories and build the program.
|
||||
|
||||
Here is a summary of the commands you would need to use to build and run the program:
|
||||
Here is a summary of the commands you would need to use:
|
||||
```bash
|
||||
git clone https://github.com/sunglocto/pi
|
||||
cd pi
|
||||
git clone https://github.com/sunglocto/pi-im
|
||||
cd pi-im
|
||||
go mod tidy
|
||||
go build .
|
||||
./pi
|
||||
./pi-im
|
||||
```
|
||||
> Uh, Windows???
|
||||
|
||||
Eventually. Don't count on it.
|
||||
Fyne has first-class support for Windows and none of my dependencies are platform dependent. I've built this app for Android before. If you compile it, it will most likely work with no issues.
|
||||
Fyne has first-class support for Windows and all of my dependencies are platform imdependent. I've built this app for Android before. If you compile it, it will most likely work with no issues.
|
||||
|
||||
Static executable snapshots are also provided for GNU/Linux systems, and CI runs on every commit, producing a binary on every successful build. You're welcome.
|
||||
Static executable snapshots are also provided for GNU/Linux systems on every new version, and CI runs on every commit, producing a binary on every successful build. You're welcome.
|
||||
|
||||
## εγκατάσταση
|
||||
(installation)
|
||||
|
||||
Pi currently has no consolidated way of installing it. There is an [Arch User Repository package available](https://aur.archlinux.org/pi-im), which is maintained by [snit](https://isekai.rocks/~snit).
|
||||
|
||||
## υποστήριξη
|
||||
(support)
|
||||
|
Reference in New Issue
Block a user