add more documentation
[pdt.git] / README
1 # pdt: post to FSF social media via command line
2 # Copyright (C) 2021 Ian Kelling
3 # SPDX-License-Identifier: AGPL-3.0-or-later
4
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU Affero General Public License for more details.
14
15 # You should have received a copy of the GNU Affero General Public License
16 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
17
18
19
20 For FSF staff: more detailed examples are on our internal wiki. Non-fsf
21 staff, if you are familiar with the command line, you aren't missing
22 anything.
23
24 FSF account names are hardcoded, if you want to use this script for
25 your own accounts, I'm happy to accept a patch or write one that uses
26 account names from a configuration file. Just email me.
27
28 Main usage: source pdt.sh, run pdt-setup one time, then usually just run
29 pdt to do posts. The documentation for each function is within the
30 pdt.sh file.
31
32 Patches welcome, email them to iank@fsf.org . If you aren't sure how
33 to send a patch, see https://git-send-email.io/