Update README.md
Some checks failed
build for freebsd / build (push) Has been cancelled
build Linux / build (push) Has been cancelled
build for macos / build (push) Has been cancelled
build for windows / build (push) Has been cancelled

This commit is contained in:
2025-08-27 11:00:27 +00:00
parent 50caef2f39
commit 8e58139fcb

View File

@@ -1,15 +1,7 @@
# REPOSITORY HAS MOVED
Pi is now being developed on my [Gitea forge](https://forge.sunglocto.net/sunglocto/pi-im).
<center>
<img width="100" height="100" src="https://github.com/sunglocto/pi/blob/255bc3749c089e3945871ddf19dd17d14a83f9ff/pi.png">
</center>
[![Linux](https://github.com/sunglocto/pi/actions/workflows/linux.yml/badge.svg)](https://github.com/sunglocto/pi/actions/workflows/linux.yml)
[![Windows](https://github.com/sunglocto/pi/actions/workflows/windows.yml/badge.svg)](https://github.com/sunglocto/pi/actions/workflows/windows.yml)
[![Darwin](https://github.com/sunglocto/pi/actions/workflows/macos.yml/badge.svg)](https://github.com/sunglocto/pi/actions/workflows/macos.yml)
[![FreeBSD](https://github.com/sunglocto/pi/actions/workflows/freebsd.yml/badge.svg)](https://github.com/sunglocto/pi/actions/workflows/freebsd.yml)
<img width="1920" height="1080" alt="image" src="https://github.com/user-attachments/assets/9e2d9209-6ad5-4f22-94d0-4cc18c835372" />
<img alt="Pi screenshot" src="https://github.com/user-attachments/assets/9e2d9209-6ad5-4f22-94d0-4cc18c835372" />
## the XMPP client from hell
@@ -68,7 +60,7 @@ The build instructions are very simple. Simply clone the repo, fetch the reposit
Here is a summary of the commands you would need to use:
```bash
git clone https://github.com/sunglocto/pi-im
git clone https://forge.sunglocto.net/sunglocto/pi-im
cd pi-im
go mod tidy
go build .
@@ -77,7 +69,7 @@ go build .
> Uh, Windows???
The commands above should be virtually identical, aside from changing `./pi-im` to `pi-im.exe`. If you compile it, it will most likely work with no issues:
<img width="1627" height="1022" alt="image" src="https://github.com/user-attachments/assets/5a6c188f-e890-4398-856c-e88f5804e9d2" />
<img alt="image" src="https://github.com/user-attachments/assets/5a6c188f-e890-4398-856c-e88f5804e9d2" />
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, for Linux, Windows and MacOS.
@@ -90,7 +82,7 @@ On BSD and Linux systems, you may want to build an executable for Wayland only,
A Wayland-only executable will also substantially decrease the level of screen tearing and lag.
```bash
git clone https://github.com/sunglocto/pi-im
git clone https://forge.sunglocto.net/sunglocto/pi-im
cd pi-im
go mod tidy
go build -tags wayland .
@@ -116,18 +108,19 @@ If you would like a more instant method of communication, join the [pi XMPP room
Pi has guaranteed support for the following operating systems:
- Windows 10 and up
- Most modern GNU/Linux installations
- FreeBSD
Pi has experimental support for the following operating system:
- Android
- Android [1]
Pi has not been tested on, but has been built on, the following operating systems:
- FreeBSD
- MacOS
Pi most likely does **not** have support for the following operating systems:
- Other BSDs
- 32-bit systems
- iOS
- ARM systems
If you use Pi on a specific operating system and it does not work, file an issue and describe the problem you have having.
@@ -166,3 +159,5 @@ The digits of Pi will reset back to `3` when moving to a new phase.
If the number gets too long, it will reset to one digit of 2π. Once that gets too long, it will be digits of 3π and etc.
Named after [Psi](https://github.com/psi-im/psi).
[1] Android is not a supported platform, however it's possible to compile and run Pi for it. If you want to become suicidal, you can go for it, but Pi is a primarily PC-oriented client. There are multiple mobile clients that already exist which will give you a substantially better experience.