Skip to content
This repository has been archived by the owner on Mar 9, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mre committed Dec 16, 2019
1 parent 6a1b942 commit 2fad98e
Showing 1 changed file with 26 additions and 23 deletions.
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,46 @@

![timelapse logo](timelapse/resources/icon.svg)

...takes screenshots and creates a video out of them to make a timelapse.
...a macOS app that takes screenshots and creates a video out of them to make a
timelapse.

[![Build Status](https://travis-ci.org/mre/timelapse.svg?branch=master)](https://travis-ci.org/mre/timelapse)


## Goals

* Simple
* Minimal CPU usage
* Extendable
- Simple
- Minimal CPU usage
- Extensible

## Why use this project?

There are many alternative solutions available.
Most of them fall into one of these categories:
There are many alternative solutions available. Most of them fall into one of
these categories:

* Commercial applications
* Custom scripts based on Automator and AppleScript
* Freeware
- Commercial applications
- Custom scripts based on Automator and AppleScript
- Freeware

This project provides an Open-Source alternative that is both,
easy to use and understand.
This project provides an _Open-Source_ alternative that is both, easy to use and
understand.

## Requirements

* macOS (any version)
* ffmpeg (run `brew install ffmpeg`)
- macOS (any version)
- ffmpeg (run `brew install ffmpeg`)

## Usage

1. Download the app from the [releases
page](https://github.com/mre/timelapse/releases).
2. Start the app.
3. A new icon appears in the menubar.
4. By clicking on it, you start and stop the screen recording.
5. Once you've finished recording, `timelapse` will create a video for you
and print the output path to the commandline.

## Development

First, install the project's dependencies:

```shell
Expand All @@ -44,20 +54,13 @@ Now run the main application from the commandline:
python timelapse
```

After that, a new icon appears in the menubar.
By clicking on it, you start and stop the screen recording.

Once you've finished recording, `timelapse` will create a video for you
and print the output path to the commandline.
You can now quit timelapse.

## License

Licensed under either of

* Apache License, Version 2.0, (LICENSE-APACHE or
- Apache License, Version 2.0, (LICENSE-APACHE or
http://www.apache.org/licenses/LICENSE-2.0)
* MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Expand Down

0 comments on commit 2fad98e

Please sign in to comment.