Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.76 KB

README.md

File metadata and controls

38 lines (30 loc) · 1.76 KB
Raw

Auto RTF

This script was made by an Android CS3714 student to instantly compile all his code into one RTF file that could easily be used to export to a PDF.

image

Requirements

You must have Python 3 or later installed on your system.

Usage

Windows/macOS

  1. Drop auto-rtf.py into your Android Studio project
  2. Double click on the file in File Explorer or Finder
  3. You should see an RTF file appear with the same name as the project folder
  4. Open this RTF file and print (CTRL+P or ⌘+P) to PDF
  5. Any time you make changes to the code, simply run the script again!

Linux/CLI

If you use Linux, or you prefer running this script from the command line, this section is for you!

Running the script with no arguments will have the same effect as Windows/macOS. However, you have more control over what the script does over the command line. Here are some helpful options:

  • --help, -h: Shows a help message describing what each option does
  • --output-file, -o: Specifies a different file name or location for the resulting RTF file
  • --project-root, -p: Specifies a root directory for an Android Studio project
  • --version, -v: Displays the current version of auto-rtf
  • --report-bug, -b: Opens the default web browser to report a bug
  • --remove-watermark, -w: Removes the watermark placed at the top of the RTF file

To run this in the command line, use python auto-rtf.py --help If that doesn't work, try python3 instead of python.

On Linux, if you want to run the script without adding python to the beginning, add #!/bin/python3 to the top of the script. I would do this myself, but then it won't run on Windows with a double-click.