Skip to content

Commit 43d6848

Browse files
committed
Improve README structure and build instructions
1 parent ad998a6 commit 43d6848

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ f'''[![build](https://github.com/python/python-docs-pl/actions/workflows/update-
2525

2626
*Read this in another language: [English](README.en.md)*
2727

28-
**Jak sprawdzić, co jest do przetłumaczenia?**
28+
### Jak sprawdzić, co jest do przetłumaczenia?
2929

3030
Służy do tego paczka `potodo`. Wywołaj ją w głównym katalogu projektu, np. `uvx potodo`.
3131

@@ -42,7 +42,7 @@ $ uvx potodo --exclude '**/*' '!tutorial/*' '!bugs.po' '!library/functions.po'`
4242

4343
Propozycje priorytetowych zasobów do tłumaczenia można znaleźć w [issue #50](https://github.com/python/python-docs-pl/issues/50).
4444

45-
**Jak tłumaczyć?**
45+
### Jak tłumaczyć?
4646

4747
* Wejdź na stronę
4848
projektu [dokumentacji Pythona](https://explore.transifex.com/python-doc/python-newest/) na Transifeksie.
@@ -55,7 +55,7 @@ projektu [dokumentacji Pythona](https://explore.transifex.com/python-doc/python-
5555
Więcej informacji o używaniu Transifeksa znajdziesz w
5656
[jego artykułach pomocy](https://help.transifex.com/en/articles/6318216-translating-with-the-web-editor) lub [w naszym przewodniku](https://python-docs-transifex-automation.readthedocs.io/new-translators.html).
5757

58-
**Jak lokalnie sprawdzić poprawność moich zmian?**
58+
### Jak lokalnie sprawdzić poprawność moich zmian?
5959

6060
[Zainstaluj Transifex CLI](https://github.com/transifex/cli#installation) i zapisz
6161
[klucz API Transifex](https://help.transifex.com/en/articles/6248858-generating-an-api-token) do `~/.transifexrc`, aby
@@ -81,26 +81,28 @@ $ uvx sphinx-lint library/turtle.po
8181
No problems found.
8282
```
8383

84-
**Jak obejrzeć najnowszy build dokumentacji?**
84+
### Jak obejrzeć najnowszy build dokumentacji?
8585

8686
Pobierz ostatnią zbudowaną dokumentację z listy artefaktów w ostatniej GitHub Action (zakładka Actions).
8787
Tłumaczenia pobierane są z Transifeksa do tego repozytorium co około godzinę.
8888
Dokumentacja na https://docs.python.org/pl/ aktualizowana jest około raz dziennie.
8989

90-
**Jak zbudować dokumentację?**
90+
### Jak zbudować dokumentację?
9191

92-
Na Uniksach zrób link symboliczny projektu `python-docs-pl` w katalogu `Doc/locales/pl` on nazwie `LC_MESSAGES`.
93-
Na Windowsie skopiuj zawartość katalogu projektu do podanej ścieżki.
92+
Aby zbudować dokumentację potrzebujesz mieć kopię repozytorium CPythona.
93+
94+
Zrób link symboliczny (Unix) lub kopię (Windows) projektu `python-docs-pl` w katalogu `Doc/locales/pl` repozytorium
95+
CPython, o nazwie `LC_MESSAGES`.
9496

9597
Następnie uruchom `make -C Doc SPHINXOPTS="-D language=pl" html` w projekcie CPython, aby zbudować dokumentację.
9698

97-
**Kanały komunikacji**
99+
### Kanały komunikacji
98100

99101
* [Discord Python Polska #dokumentacja](https://discord.gg/VCyBDGH38e)
100102
* [Python Documentation Community](https://docs-community.readthedocs.io/en/latest/)
101103
* [Python Documentation Special Interest Group](https://www.python.org/community/sigs/current/doc-sig/)
102104

103-
**Postęp tłumaczenia**
105+
### Postęp tłumaczenia
104106

105107
<img src="translation_progress_pl.svg" alt="Postęp tłumaczenia">
106108

@@ -109,25 +111,25 @@ Excludes the changelog from calculations.
109111
Made using: https://gist.github.com/StanFromIreland/ce400e0d497018fc8e8eb6b739e0b8eb
110112
--->
111113

112-
**Licencja**
114+
### Licencja
113115

114116
Zapraszając do współtworzenia projektu na platformie Transifex, proponujemy umowę na
115117
przekazanie twoich tłumaczeń Python Software Foundation
116118
[na licencji CC0](https://creativecommons.org/publicdomain/zero/1.0/deed.pl).
117119
W zamian będzie widoczne, że jesteś tłumaczem(-ką) części, którą przetłumaczyłeś(-łaś).
118120
Wyrażasz akceptację tej umowy, przesyłając swoją pracę do włączenia do dokumentacji.
119121

120-
**Aktualizacja tłumaczeń**
122+
### Aktualizacje w repozytorium
121123
* `./manage_translation.py recreate_tx_config`
122124
* `./manage_translation.py fetch`
123125
* `cog -rP README.md`
124126

125-
**Przydatne materiały**
127+
### Przydatne materiały
126128
* [Python Developer's Guide: Translating](https://devguide.python.org/documentation/translations/translating/)
127129
* [Python docs Transifex: Documentation](https://python-docs-transifex-automation.readthedocs.io/)
128130
* [statystyki oglądalności](https://analytics.python.org/docs.python.org?f=contains,page,/pl/)
129131

130-
**Podobne projekty**
132+
### Podobne projekty
131133
* [projekty Python Packaging Authority](https://hosted.weblate.org/projects/pypa/-/pl/)
132134
* [Scientific Python Translations](https://scientific-python-translations.github.io/)
133135
* [micro:bit translation programme](https://microbit.org/translate/)

0 commit comments

Comments
 (0)