Skip to content

Commit

Permalink
Added setup instructions to the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdoms committed Nov 14, 2014
1 parent 6d0244c commit 5bc25c1
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,30 @@ Copyright © 2009, [Brendan Doms](http://www.bdoms.com/)
Licensed under the [MIT license](http://www.opensource.org/licenses/MIT)


# Tumblr Backup

Tumblr Backup is a tool for making a local backup of your Tumblr account.


## Setup

There is one dependency: version 3 of [Beautiful Soup](http://www.crummy.com/software/BeautifulSoup/).
If you already have it installed globally then you can grab the single `.py` file and it should work.

Otherwise, the easiest way is to clone the repository with `--recursive` to get all the required submodules automatically:

```bash
git clone --recursive https://github.com/bdoms/tumblr_backup.git
```

If you have the code but didn't clone with `--recursive` you can still get the submodules later:

```bash
git submodule init
git submodule update
```


## Use

To backup your account, just include the URL of your Tumblr website:
Expand Down

0 comments on commit 5bc25c1

Please sign in to comment.