Skip to content

Add usage descrpiton, better for newbie #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
csufuyi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add usage descrpiton, better for newbie #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you want to run from source and not install:

```bash
git clone https://github.com/theonewolf/TermRecord.git
src/TermRecord -o /tmp/test.html -m templates/static.jinja2
bin/TermRecord -o /tmp/test.html -m termrecord/templates/static.jinja2
```

replacing `/tmp/test.html` with whatever you want the output file to be named.
Expand Down Expand Up @@ -73,7 +73,7 @@ like iPads etc.). Basically, the consumer only needs a modern browser.
## Usage

Just getting started? The defaults are probably fine for you, just specify an
output HTML file and go: `TermRecord -o mysession.html`. For more complex
output HTML file and go: `TermRecord -o mysession.html`. After recording, type: `exit`, then check `mysession.html`. For more complex
operations checkout `TermRecord --help`.

There are three main modes of operation: (1) wrap the `script` program and dump
Expand Down