X-Git-Url: https://git.mdrn.pl/wolnelektury.git/blobdiff_plain/735368cfb54c8954518179993dcd3bc55e3878e7..cf76dbd53927cb38154845748fb3481cf013970f:/README.md?ds=inline diff --git a/README.md b/README.md index c6590b600..ef163d391 100644 --- a/README.md +++ b/README.md @@ -1,143 +1,87 @@ -License -------- - - ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png) - - Copyright © 2008,2009,2010 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 -============ - - * All packages listed in requirements.txt - * Python libraries from lib directory - * Django applications from apps directory - -How to deploy (development version) -============= - -1. Checkout the source code from Github -2. Install libraries (we recommend using pip): - - pip install -r requirements.txt - -3. Setup your local configuration based on settings.py. You need to generate a new SECRET_KEY, database stuff and domain related stuff. -4. Populate database: - - ./wolnelektury/manage.py syncdb - ./wolnelektury/manage.py migrate - -5. Run the server - - ./wolnelektury/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). - -Full list of used open-source software -====================================== - -External --------- - -django --------- - - Source: [djangoproject.com](http://www.djangoproject.com/) - - Authors: [many authors](http://code.djangoproject.com/browser/django/trunk/AUTHORS) - - License: [BSD License](http://code.djangoproject.com/browser/django/trunk/LICENSE) - - Type: framework - -django-pagination ------------------ - - Source: [Google Code](http://code.google.com/p/django-pagination/) - - Authors: James Tauber , leidel@gmail.com - - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php) - - Type: library (aplikacja django) - -Django South ------------- -- Source: [aercode.org](http://south.aeracode.org/) -- Authors: Andrew Godwin , Andy McCurdy -- License: [Apache License 2.0](http://www.opensource.org/licenses/apache2.0.php) -- Type: library (aplikacja django) - -lxml ---------- - - Żródła: [codespeak.net](http://codespeak.net/lxml/index.html#download) - - Authors: [many authors](http://codespeak.net/lxml/credits.html) - - License: [BSD License](http://codespeak.net/lxml/index.html#license) - - Type: library - -feedparser ----------- - - Source: [Google Code](http://code.google.com/p/feedparser/) - - Authors: Mark Pilgrim - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library - - -Internal (means we hacked on sources of those): ---------- - -django-compress ---------------- - - Source: [Google Code](http://code.google.com/p/django-compress/) - - Authors: Andreas Pelme - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library (Django aplication) - - django-chunks -------------- - - Source: [Google Code](http://code.google.com/p/django-chunks/) - - Authors: Clint Ecker - - License: [New BSD License](http://www.opensource.org/licenses/bsd-license.php) - - Type: library (Django aplication) - -django-newtagging ------------------ - - Source: [BitBucket](http://www.bitbucket.org/zuber/django-newtagging/) - - Authors: Marek Stępniowski - - License: [MIT License](http://www.opensource.org/licenses/mit-license.php) - - Type: library (Django aplication) - - Notes: Aplication based on [django-tagging](http://code.google.com/p/django-tagging/), also [MIT](http://www.opensource.org/licenses/mit-license.php) license. - -django-piston (0.2.3rc) ------------------------- - - http://bitbucket.org/jespern/django-piston/wiki/Home - -markupstring +# 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 ------------ - - Source: [ASPN Cookbook](http://code.activestate.com/recipes/389023/) - - Authors: Thomas Hinkle - - License: [MIT License](http://code.activestate.com/help/terms/) - - Type: library - - Notes: Patched by Marek Stępniowski to accept Unicode strings - - -Authors -======= - - * Marek Stępniowski - * Łukasz Rekucki + +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 + * Aleksander Łukasz + * Jan Szejko + * Mariusz Machuta