diff --git a/README b/README new file mode 100644 index 0000000..30266ef --- /dev/null +++ b/README @@ -0,0 +1,40 @@ +Copyright © 2017 Paulina Laura Emilia + +You can redistribute this file and/or modify it under the terms of the Do What +The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. +See the COPYING file for more details. + +* Skrypty importu Encyklopedii Wandejskiej + +Znajdujące się tutaj skrypty ułatwiają import artykułów z Micropedii oraz +SclaviniaWiki do Encyklopedii Wandejskiej. Wymagają one do swojego działania +systemu operacyjnego zgodnego ze standardem POSIX, takiego jak GNU/Linux lub +systemy z rodziny BSD, oraz narzędzia konwertującego Pandoc: http://pandoc.org/ + +** mediawiki2ency.sh + +Konwertuje pliki tekstowe sformatowane za pomocą znaczników MediaWiki na używany +w Systemie Stron Wandejskich dialekt Markdowna i dodaje informację o źródle +artykułu oraz jego licencji. Zalecane użycie: + + ./mediawiki2ency.sh [--sclavinia] plik_źródłowy "Tytuł strony" > plik_docelowy + +** encyimport.sh + +Pobiera artykuły z Micropedii i SclaviniaWiki według listy podanej na +standardowym wejściu i zapisuje je w katalogu bieżącym pod nazwą +`Encyklopedia::Tytuł_strony.txt'. Do swojego działania wymaga skryptu +mediawiki2ency.sh w jednym z katalogów ścieżki wyszukiwania ($PATH) lub +w katalogu bieżącym. Zalecane użycie: + + ./encyimport.sh [--sclavinia] < plik_z_listą_stron + +Skrypt został napisany z zamiarem bezpośredniego użycia na serwerze wandejskim, +ale oczywiście może być też używany do zbiorowego pobierania artykułów na +komputer lokalny. + +** Contributing + +Jeżeli posiadasz propozycję poprawki, gotowego patcha, nowy skrypt lub po prostu +chcesz zgłosić błąd, skontaktuj się z tow. Polyną wysyłając wiadomość e-mail +na adres .