Change README.

This commit is contained in:
Jim Miller 2015-04-08 14:22:51 -05:00
parent b3e72a271c
commit 7319760afa
2 changed files with 17 additions and 37 deletions

17
README.md Normal file
View file

@ -0,0 +1,17 @@
FanFicFare
==========
This is a repository for the FanFicFare project.
FanFicFare is the rename and move of the FanFictionDownLoader (AKA
FFDL, AKA fanficdownloader) project previously hosted as a
[code.google project].
This program is available as a calibre plugin, a command-line
interface, and a web service.
*Currently, the project is the middle of being moved from code.google
to GitHub and being renamed. For now, continue to use
FanFictionDownLoader(FFDL).*
[code.google project]: https://code.google.com/p/fanficdownloader/

View file

@ -1,37 +0,0 @@
# -*- coding: utf-8 -*-
# Copyright 2011 Fanficdownloader team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Other code contributed by Pau Sanchez(bbcodeutils).
To use, do:
python downloader.py [-f (epub|html|txt)] <url>
Default format is epub.
Eg:
python downloader.py http://www.fanfiction.net/s/5192986/1/A_Fox_in_Tokyo
Do 'python downloader.py -h' for more options.
This tool uses Python 2.7, but should work with newer versions of Python.
For more information, see:
http://code.google.com/p/fanficdownloader/wiki/FanFictionDownloaderSupportedsites
http://code.google.com/p/fanficdownloader/wiki/FanFictionDownloaderFAQs