docs/docs-importer/README.md

35 lines
858 B
Markdown
Raw Permalink Normal View History

2018-03-01 12:28:29 +01:00
File Importer
=============
This tool can be used to do a single import of files or to periodically scan for files in an input folder.
2018-03-01 14:18:23 +01:00
Downloads
---------
Built binaries for Windows/Linux/MacOSX can be found at <https://github.com/sismics/docs/releases>
2018-03-01 12:28:29 +01:00
Usage
-----
```console
2018-03-01 14:18:23 +01:00
./docs-importer-macos (for MacOSX)
./docs-importer-linux (for Linux)
docs-importer-win.exe (for Windows)
2018-03-01 12:28:29 +01:00
```
A wizard will ask you for the import configuration and write it in `~/.config/preferences/com.sismics.docs.importer.pref`
For the next start, pass the `-d` argument to skip the wizard:
```console
./docs-importer-linux -d
```
2018-03-01 12:28:29 +01:00
Daemon mode
-----------
2018-03-01 14:18:23 +01:00
The daemon mode scan the input directory every 30 seconds for new files. Once a file is found and imported, it is **deleted**.
Build from sources
------------------
```console
npm install
npm install -g pkg
pkg .
```