summaryrefslogtreecommitdiff
path: root/README.md
blob: 2297f634024259ae92d44c6b634be09dcf0ef66d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Scripts, utilities, and other files related to life at YK Pao School

Most of these are written in C, Go, shell script, and occasionally prototypes in Python. While I try to make things portable, sometimes I might foget, or sometimes GNU Bash extensions are just too convenient, so there is no guarantee that any of this would run on macOS. But they should at least work on Asahi/Fedora.

## Contents

|Program|Language|Description|
|--|--|--|
|`chphoto`|Go|Change Outlook profile photos|
|`memch`|C|Help memorize classical Chinese texts|
|`pdfutils`|Shell|Help manipulate PDFs|
|`sjauth`|C|Log on to [STUWIRELESS](https://ykps.runxiyu.org/wifi)|
|`ykpsmuttauth`|Go, C|Get XOAUTH2 tokens for mutt/aerc for Outlook|

## Build

Only GNU Make is supported. Users on BSD systems should call `gmake` instead of `make`.

The top-level makefile simply builds subdirectories. Each subdirectory is a phony target, so you could type `make sjauth` to build `sjauth`. The resulting binary is copied to `bin/sjauth`. The `install` target *additionally* causes the binaries to be copied over to `~/.local/bin/`.

## Contributing

Issues and post requests submitted via the [Codeberg](https://codeberg.org/runxiyu/tooch) and [Github](https://github.com/runxiyu/tooch) repositories are accepted. However, the maintainer prefers [emailed patches](https://git-send-email.io) and emailed bug reports, to the [mailing list](https://lists.sr.ht/~runxiyu/ykps).