X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/154870f0416b6b387637d6035c96321410512e95..7a27a3fbc14b2049b8d110db15855a625e4c2455:/README.md?ds=inline diff --git a/README.md b/README.md index 45c7e4e23..ef163d391 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,84 @@ -License -------- - - ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) - - Copyright © 2008-2019 Fundacja Nowoczesna Polska - - For full list of contributors see AUTHORS section at the end. - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Dependencies -============ - - * Python 3.4+ - * All packages listed in requirements.txt - * Sass>=3.2 - -How to deploy (development version) -============= - -1. Checkout the source code from Git and enter the directory -2. Install libraries (we recommend using pip): - - pip install -r requirements/requirements.txt - -3. Setup your local configuration in src/wolnelektury/localsettings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff. -4. Populate database: - - ./manage.py migrate - -5. Run the server - - ./manage.py runserver - - -6. Import some books which are available on http://www.wolnelektury.pl or on bitbucket mirror: http://bitbucket.org/lqc/wlbooks/ - If you use Bitbucket, you also need Mercurial to fetch books (you can install it using: pip install mercurial). - After downloading books, log into administration, go to Books and choose 'Browse' to select book file, - then fire 'Import book' to upload it. Some books have invalid XML, so you can get an error - (just ignore it and look for other books). - -7. We provide localization of the software in following languages: Polish, Russian, German, English, Spanish, French and Lithuanian. - Translation strings are based on gettext and can be found under 'locale' dir. - There are also JavaScript files for jQuery countdown plugin (static/js/jquery.countdown-*.js). - -Bundled software -================ - -* django-chunks - in `apps/chunks` - based on [django-chunks](http://code.google.com/p/django-chunks/) - by Clint Ecker , - [New BSD License](http://www.opensource.org/licenses/bsd-license.php) -* [django-newtagging](http://www.bitbucket.org/zuber/django-newtagging/) - in `apps/newtagging` - by Marek Stępniowski , - [MIT License](http://www.opensource.org/licenses/mit-license.php), - based on [django-tagging](http://code.google.com/p/django-tagging/), also under [MIT License](http://www.opensource.org/licenses/mit-license.php) -* [jPlayer](http://jplayer.org/) - in `apps/catalogue/static/jplayer` - by Happyworm, - [MIT License](http://opensource.org/licenses/MIT) -* [Switch template tag](http://djangosnippets.org/snippets/967/) - in `apps/wolnelektury_core/templatetags/switch_tag.py` - by adurdin -* [Cropping engine for sorl-thumbnail](http://timmyomahony.com/blog/custom-cropping-engine-sorl-thumbnail/) - in `apps/picture/engine.py` - by Timmy O'Mahony -* Javascript in `apps/wolnelektury_core/static/js/contrib` - with relevant attribution and licensing - - - -Authors -======= - * Marek Stępniowski - * Łukasz Rekucki +# Wolne Lektury + +![Wolne Lektury](src/wolnelektury/static/img/logo-bez.png) + +Wolne Lektury to wolna biblioteka internetowa. Udostępniamy wysokiej jakości +książki — lektury szkolne i nie tylko — dzieciom i dorosłym w Polsce i na całym +świecie. To ważne, ponieważ w 32% domów w Polsce nie ma ani jednej książki +(dane Biblioteki Narodowej, 2022). Wyrównujemy szanse edukacyjne, w praktyce +realizujemy wolność korzystania z dóbr kultury. + +Wszystkie dzieła są przez nas opracowane — uwspółcześniane, opatrzone +przypisami, motywami, odniesieniami kontekstowymi — i udostępnione w kilku +formatach do czytania online lub pobrania na własne urządzenie (HTML, TXT, PDF, +EPUB, MOBI, FB2). Nagraliśmy i udostępniliśmy także ponad tysiąc audiobooków, +czytanych przez wybitnych lektorów. Przygotowujemy je także w formatach +z synchronizacją audio-tekst (DAISY i EPUB 3 MO). + +Jesteśmy częścią ruchu wolnego internetu, wolnej kultury i wolnego +oprogramowania — zarówno nasze oprogramowanie, jak i treści, publikujemy +wyłącznie na wolnych licencjach. Udostępniamy teksty z domeny publicznej, +wykupujemy prawa do utworów współczesnych, a nawet zamawiamy i wydajemy +[nowe tłumaczenia](https://wolnelektury.pl/katalog/lektury/nowe-tlumaczenia-wl/) +takich klasyków jak Doktor Dolittle, Mały Książę, Inwazja jaszczurów, Rok 1984. + + +Jak możesz pomóc? +================= + +Wesprzyj nas +------------ + +Wolne Lektury nie mają stałego źródła finansowania. +**[Wspieraj Wolne Lektury stałą wpłatą](https://wolnelektury.pl/pomagam/)** – nawet +niewielkie, stałe wsparcie ma wielką moc! Możesz też wesprzeć Wolne Lektury jednorazowo. + +![1,5%](https://wolnelektury.pl/media/chunks/attachment/poltora-procent.png) + +Fundacja Wolne Lektury jest *Organizacją Pożytku Publicznego*. Dzięki temu możesz +przekazać na bibliotekę 1,5% podatku, podając +[KRS 0000070056](https://fundacja.wolnelektury.pl/pomoz-nam/1-procent/). +Pamiętaj też, że swoje darowizny na Wolne Lektury możesz odliczyć od podstawy podatku! + +Pomóż w tłumaczeniu serwisu +--------------------------- + +Tłumaczenie interfejsu serwisu na inne języki jest przydatne zwłaszcza +dla osób uczących się polskiego, imigrantów i dzieci polonijnych — możesz +pomóc uzupełnić te tlumaczenia. Odbywa się to +[w serwisie Weblate](https://hosted.weblate.org/engage/wolnelektury/). + + +Stan tłumaczenia + + + +Pracuj jako fundraiser/fundraiserka +----------------------------------- + +[Szukamy osób na stanowisko fundraisera](https://wolnelektury.pl/info/rekrutacja/). +Praca polega na bezpośrednim kontakcie z potencjalnymi darczyńcami +podczas festiwali muzycznych i kulturalnych. + + +Włącz się w prace redakcyjne +---------------------------- + +Zobacz jak możesz włączyć się bezpośrednio +w [prace redakcyjne](https://wolnelektury.pl/info/wlacz-sie-w-prace/). + + +Prawa i autorzy +=============== + +Oprogramowanie jest dostępne na wolnej licencji GNU AGPL — dokładniejsze +informacje znajdziesz w plikach NOTICE i LICENSE. Utrzymaniem oprogoramowania +w ramach Fundacji Wolne Lektury zajmuje się Radek Czajka. + +Pełna lista dotychczasowych autorów: + + * Marek Stępniowski + * Łukasz Rekucki * Radek Czajka * Łukasz Anwajler * Marcin Koziej