public/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2025-12-15 18:56:18 +00:00
Code Issues Releases Wiki Activity

v1.5

Browse Source
This commit is contained in:
Benjamin Gamard
2018-03-01 14:18:23 +01:00
parent f70cded634
commit ea210d6aac
7 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs-importer/README.md
View File

@@ -3,20 +3,28 @@ File Importer
This tool can be used to do a single import of files or to periodically scan for files in an input folder.
Requirements
------------
- NodeJS 9
- NPM
Downloads
---------
Built binaries for Windows/Linux/MacOSX can be found at <https://github.com/sismics/docs/releases>
Usage
-----
```console
npm install
node main.js
./docs-importer-macos (for MacOSX)
./docs-importer-linux (for Linux)
docs-importer-win.exe (for Windows)
```
A wizard will ask you for the import configuration and write it in `~/.config/preferences/com.sismics.docs.importer.pref`
Daemon mode
-----------
The daemon mode scan the input directory every 30 seconds for new files. Once a file is found and imported, it is **deleted**.
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 .
```