Слияние кода завершено, страница обновится автоматически
This repository contains the official KiCad documentation.
You can discuss the documentation and its translations in the repository issues.
To participate to the translation effort read the translation_instructions.adoc.
Submit your translation pull requests to the stable docs branch 5.1, please.
See docs-versioning.adoc for details about docs versioning.
The following instructions explain how to test changes before submitting a pull-request.
Asciidoctor >= 2.0 is both the language of the documentation and the tool used to generate the HTML outputs.
asciidoctor-web-pdf is used to generate the PDF outputs.
po4a v0.44 < version < v0.55 is used to translate the English AsciiDoc documentation to other languages before the last compilation steps.
CMake >= 2.8
gettext >= 0.18
To install the dependencies on Debian / Ubuntu run the following (requires about 1.5GiB of space):
sudo apt-get install cmake fonts-freefont-ttf \ fonts-vlgothic gettext git make po4a source-highlight \ libunicode-linebreak-perl sudo gem install asciidoctor sudo npm i -g @asciidoctor/core asciidoctor-web-pdf
To install the dependencies to build the documentation on Fedora, run the following:
sudo dnf install -y cmake po4a rubygem-asciidoctor npm git sudo npm install -g puppeteer --unsafe-perm=true sudo npm install -g @asciidoctor/core asciidoctor-web-pdf --unsafe-perm=true
To obtain and build the documentation, run the following:
git clone https://gitlab.com/kicad/services/kicad-doc.git cd kicad-doc mkdir build cd build cmake .. make sudo make install
|
Note
|
These instructions are outdated and should be updated by someone familiar with Manjaro |
To install the dependencies on Manjaro run the following:
sudo pacman -S asciidoc cmake dblatex ttf-freefont gettext po4a \ source-highlight texlive-langchinese texlive-langcyrillic \ texlive-langjapanese texlive-langextra texlive-langkorean \ texlive-langgreek perl-unicode-linebreak
|
Note
|
AUR package |
yay -S ttf-vlgothic asciidoctor-web-pdf
Start with windows_dependencies.adoc then run:
cd kicad-doc mkdir build cd build cmake -G "MinGW Makefiles" -DPDF_GENERATOR=FOP ../ make
cd kicad-doc mkdir build cd build cmake ../ make
or: Use ninja for accelerated compilation (Note: ninja needs to be installed)
cd kicad-doc cmake -Bbuild -GNinja ninja -C build
Read utils/docker/README.adoc if you want to build the documentation in a container.
By default BUILD_FORMATS is set to "html;pdf" to enable building all supported
document formats.
It’s possible to set BUILD_FORMATS in order to build only a subset of formats,
e.g. -DBUILD_FORMATS=html
When only one build format is enabled the package name is transformed to include the format.
By default CMake will configure to build all languages available for each document.
You can build just one or some of the languages by using the LANGUAGES option
when configuring a build with CMake, e.g. -DLANGUAGES="it;en;de", etc.
Currently, the available languages are : ca, de, en, es, fr, id,
it, ja, pl, ru and zh, however, any language code can be selected.
Only translated documents will be built, so for some languages there may only
be a partial documentation output.
By default CMake will use asciidoctor-web-pdf for building PDFs.
You can build PDFs however using either DBLATEX or FOP by using the
PDF_GENERATOR option whilst configuring a CMake build.
For example, use -DPDF_GENERATOR=FOP to use FOP to build the PDFs. If the
BUILD_FORMATS option doesn’t include pdf, the PDF_GENERATOR option
will have no effect on the build.
This option doesn’t transform the built package name.
The docs use CMake as mentioned earlier, so to install it as a packager use the normal CMake way, for example:
mkdir build; cd build cmake -DCMAKE_INSTALL_PREFIX=/usr .. make install
And if on OS X you might want something like:
mkdir build; cd build cmake -DCMAKE_INSTALL_PREFIX="/Library/Application Support/kicad" .. make install
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Опубликовать ( 0 )