diff options
| author | Lars-Dominik Braun <lars@6xq.net> | 2019-07-04 13:53:30 +0200 |
|---|---|---|
| committer | Lars-Dominik Braun <lars@6xq.net> | 2019-07-04 13:53:30 +0200 |
| commit | 799c79638b9bdebd7d04c524a2dd6e8779057679 (patch) | |
| tree | 5ab5f8250cc771838e4f9de2fe3ea2d9411fd78b /doc/usage.rst | |
| parent | e7eb6fcd4781a907bf698a88df9cb34b5b31c369 (diff) | |
| download | crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.gz crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.tar.bz2 crocoite-799c79638b9bdebd7d04c524a2dd6e8779057679.zip | |
Update documentation
Re-arrange stuff, add release guide. Needs a lot more work though.
Diffstat (limited to 'doc/usage.rst')
| -rw-r--r-- | doc/usage.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/usage.rst b/doc/usage.rst index a3c2cc7..b070f5c 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -1,18 +1,26 @@ Usage ----- -One-shot command line interface and pywb_ playback: +Quick start using pywb_, expects Google Chrome to be installed already: .. code:: bash - pip install pywb + pip install crocoite pywb crocoite http://example.com/ example.com.warc.gz - rm -rf collections && wb-manager init test && wb-manager add test example.com.warc.gz + wb-manager init test && wb-manager add test example.com.warc.gz wayback & $BROWSER http://localhost:8080 .. _pywb: https://github.com/ikreymer/pywb +It is recommended to install at least Micrsoft’s Corefonts_ as well as DejaVu_, +Liberation_ or a similar font family covering a wide range of character sets. +Otherwise page screenshots may be unusable due to missing glyphs. + +.. _Corefonts: http://corefonts.sourceforge.net/ +.. _DejaVu: https://dejavu-fonts.github.io/ +.. _Liberation: https://pagure.io/liberation-fonts + IRC bot ^^^^^^^ |