Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephen-Hamilton-C authored Sep 9, 2023
1 parent 5045d2a commit 510aede
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Auto RTF
This script was made by an annoyed CS3714 student to instantly compile all his
code into one rtf file that could easily be used to export to a PDF.
code into one RTF file that could easily be used to export to a PDF.

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

## Usage
### Windows/macOS
Expand All @@ -20,3 +23,11 @@ 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

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.

0 comments on commit 510aede

Please sign in to comment.