1  # This is aethertool, a command-line tool for aether websites
 2  Copyright (C) 2005-2021 Jeff Epler <jepler@unpythonic.net>
 3  
 4  ## REQUIREMENTS
 5  
 6   *  Python 3.x  to execute the scripts
 7   *  convert     to resize images
 8   *  pngcrush    to improve the compression of png images
 9   *  jpegtran    to improve the compression of jpeg images and perform lossless rotation of digital camera pictures when EXIF orientation data is available
10  
11  
12  ## INSTALLATION
13  
14  To do a single-user installation:
15  ```
16  pip install .
17  ```
18  This may require configuration of your $PATH.
19  
20  Aethertool can also be used "in place" without installation.
21      
22  
23  ## USAGE
24  
25  For help with commandline options, use "aethertool.py -h".  For help on the
26  configuration syntax, use "aethertool.py -c help".
27  
28  
29  # BUGS
30  
31  Aethertool assumes that your browser is called "firefox"; it should use
32  the webbrowser module instead
33  
34  Aethertool assumes the command used to invoke the editor doesn't exit
35  until the user is done editing the file.  This can cause problems if the
36  editor naturally starts in the background.
37  
38  If the user does a 'write and exit' sequence, the file the browser loads
39  to submit page changes may be removed too early, and the last edit lost.
40  
41  
42  # COPYRIGHT
43  
44  This program is free software: you can redistribute it and/or modify it under
45  the terms of the GNU General Public License version 3 as published by the Free
46  Software Foundation.
47  
48  This program is distributed in the hope that it will be useful, but WITHOUT ANY
49  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
50  PARTICULAR PURPOSE.  See the GNU General Public License for more details.
51  
52  You should have received a copy of the GNU General Public License
53  along with this program.  If not, see <http://www.gnu.org/licenses/>.