MLAB wiki

User Tools

Site Tools

Trace:
en:tools

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
en:tools [2019/02/17 15:10] – fluktuaciaen:tools [2019/02/19 14:20] – fluktuacia
Line 458: Line 458:
 Setting of set merging is found in the layout.cfg file and the placement.merge.txt file contains the requested set layout. A file with set layout will be generated automatically during the first startup of grebmerge programme.  Setting of set merging is found in the layout.cfg file and the placement.merge.txt file contains the requested set layout. A file with set layout will be generated automatically during the first startup of grebmerge programme. 
  
-Vygenerování takto připravených dat se provede následujícím příkazem:+Generating such prepared data can be done using a following command:
   ../../src/gerbmerge/gerbmerge.py --place-file=placement.merge.txt layout.cfg   ../../src/gerbmerge/gerbmerge.py --place-file=placement.merge.txt layout.cfg
      
 == GerberTools == == GerberTools ==
  
-[[https://github.com/ThisIsNotRocketScience/GerberTools|GerberTools]] je zatím nevyzkoušený open-source nástroj napsaný primárně pro Windows v C#.  +[[https://github.com/ThisIsNotRocketScience/GerberTools|GerberTools]] is so far untried open-source tool written primarily for Windows in C#.
  
  
-==== Gkódy pro 3D tisk ====+==== Gcodes for 3D print ====
  
-Technologická data pro 3D tisk v MLABu generujeme programem [[http://slic3r.org/|Slic3r]]. Zatím od něj neexistují připravené balíky v použitelné verzi. Proto je nutné program přeložit přímo ze zdrojových souborů na githubu. +Technological data for 3D printing are in MLAB generating using [[http://slic3r.org/|Slic3r]] software. So far, there are not any ready-made usable packages. Therefore it is necessary to translate the programme directly from the source codes found on GitHub.
  
  
-=== Instalace Slic3r ===+=== Slic3r Installation ===
  
   sudo apt-get install libextutils-cppguess-perl freeglut3-dev   sudo apt-get install libextutils-cppguess-perl freeglut3-dev
-=== Postup kompilace === 
  
-Z githubu se aktuálně používá master větev, která je kompromisem mezi stabilitou a možnostmi software. Samotná kompilace pak probíhá vetšinou podle instrukcí v souboru README.md+=== Compilation ===
  
 +Currently, a Github’s master branch is used - it is a compromise between stability and the software’s possibilities. The compilation itself is done mostly according to instructions from README.md file.
  
-===== Programátorské nástroje ===== 
  
-Na většinu programování softwaru se používá se v MLABu používá Python, nebo C. Vývojové nástroje jsou pro tyto jazyky dobře obecně známé. Většina vývoje je navíc orientována na Linux.  Proto zde uvedeme jen seznam nástrojů, které používáme. +===== Programming tools =====
  
-==== Programovací GUI ====+Most of the software programming in MLAB uses Python or C. Development tools for these languages are generally well known. Furthermore, most of the development is aimed at Linux. That is why we only provide a list of tools that we use. 
  
-Programovací prostředí v kterém je vytvářen zdrojový kód. Mezi uživateli jsou nejoblíbenější následující dvě volby. Jinak lze ale zdrojový kód psát v libovolném textovém editoru. +==== Programming GUI ==== 
 + 
 +A programming environment where the source code is created. The most favourite among users are the following two option - however, the source code can be written in any text editor. 
  
 === Light Table === === Light Table ===
  
-[[http://lighttable.com/|Light Table]] je programátorský editor kódu, který vyniká speciálními vlastnostmi, jako je například interaktivní spouštění částí zdrojových kódů, nebo přímé vyhledávání v dokumentaci.  +[[http://lighttable.com/|Light Table]] is a code editor that excels at some special features, such as interactive running of sections of source code or direct search in documentation. Its installation can be done by downloading a compiled package from [[http://lighttable.com/|Light Table Download]], unpacking it and running the following commands that will move it to system folders.
-Jeho instalaci do systému provedeme stažením zkompilovaného balíku z stránky [[http://lighttable.com/|Light Table Download]], rozbalením staženého balíku a provedením následujících příkazů, které jej přesunou do systémových složek.+
  
   sudo mv LightTable /opt/LightTable   sudo mv LightTable /opt/LightTable
Line 496: Line 496:
 === Sublime text === === Sublime text ===
  
-Multiplatformní placený editor pro linux, Windows, Mac OS.  Mezi jeho vyjímečné vlastnosti patří například náhled celého zdrojového kódu. Pro běžné použití stačí nezaplacená varze. +A Multiplatform paid editor for linux, Window and Mac OS. Some of its special features include an overview of the whole source code. Free version is sufficient for ordinary use. 
  
-== Instalace v Ubuntu ==+== Ubuntu installation ==
  
  
Line 504: Line 504:
   sudo apt-get update   sudo apt-get update
   sudo apt-get install sublime-text-installer   sudo apt-get install sublime-text-installer
 +
 === Code::Blocks === === Code::Blocks ===
  
-Jde o velmi rozřířený editor, jehož výhodou je, že běží na více platformách a mohou ho tedy používat i uživatelé windows.+A widely used editor. It’s advantage is that it runs under various platforms and thus can be used by Windows users as well. 
  
 [[http://www.codeblocks.org/|Code::Blocks]] [[http://www.codeblocks.org/|Code::Blocks]]
Line 513: Line 514:
      
  
-==== Embeded systémy ====+==== Embeded systems ====
  
-Nástroje na programování jednotlivých typů mikrokontrolérů jsou většinou popsány v částech týkajících se programování u jednotlivých architektur: +Tools used for programming individual types of microcontrollers are mostly described in sections related to programming under different architectures.
  
 === PIC === === PIC ===
Line 523: Line 524:
 === AVR === === AVR ===
   * [[cs:avr_programming|AVR]]   * [[cs:avr_programming|AVR]]
-===== Správa verzí =====+===== Version Control =====
  
  
Line 531: Line 532:
 ==== GitHub ==== ==== GitHub ====
  
-Pro správu softwarového vývoje a dokumentace modulů používáme [[https://github.com/MLAB-project|github]]. +[[https://github.com/MLAB-project|github]] is used for management of software development and modules’ documentation.
  
 === Linux === === Linux ===
  
-Jako nejefektivnější uživatelské rozhraní pro git se osvědčil příkazový řádek s tím, že jeho efektivita je zde ještě markantnější než u SVN.+The most effective user interface for git seems to be the command line - here its efficiency is even more striking than in SVN.
  
-== Nový uživatel == +== New user ==
-Pro pohodlnou ptáci s git je efektivnější používat metodu klonování s SSH. Není při práci vyžadováno stále přihlašování. Komunikace je autentizována na základě privátního klíče. Pro každý počítač je potřeba vygenerovat unikátní klíč.+
  
-  - Je potřeba si založit uživatelský účet na https://github.com/ +For a comfortable work with git it is effective to use a method of cloning with SSH - then there is no need for permanent logging in during work. Communication is authenticated base on a privet key. Every computer needs to have a unique one generated. 
-  - Následně je potřeba [[https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/|vygenerovat na daném počítači SSH klíč]]. +
-  - Vygenerovaný klíč je potřeba [[https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/|vložit do účtu na githubu]] +
-  - Pokud v návodu nefunguje správně uložení klíče do schránky, tak je možné daný klíč získat otevřením skrytého souboru a provést překopírování klíče ručně. ''cat ~/.ssh/id_rsa.pub'' +
-  - Tento postup stačí provést jen při prvním stahování na daném počítači.+
  
-== Základní příkazy ==+  - You need to create a user account on https://github.com/ 
 +  - Next, you have to [[https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/|generate an SSH key for the specific computer]]. 
 +  - The generated key has to be [[https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/|added into your github account]] 
 +  - If the addition of the key into clipboard (?? Schránka) does not work properly, it is possible to obtain the key via opening a hidden file and then copying the key manually. ‘’cat ~/.ssh/id_rsa.pub'' 
 +  - This procedure only has to be done during the first download to a given computer.
  
-== Klonování repozitáře : ==+== Basic commands ==
  
-  - Nejprve je potřeba vybrat místo, kde má být repozitář v počítači uložen a v daném místě si otevřít příkazový řádek. +== Cloning a repository : ==
-  - Příklad bude ukázán na repozitáři kicad-mlab: https://github.com/MLAB-project/kicad-mlab +
-  - Na dané stránce si stáhneme potřebnou cestu k repozitáři. Webové tlačítko "Clone or download". +
-  - Je potřeba si přepnout cestu pro "Clone with SSH", na místo "Clone with HTTPS". +
-  - Pro náš případ cesta vypadá takto: git@github.com:MLAB-project/kicad-mlab.git +
-  - Nyní stačí v příkazové řádce zadat příkaz:+
  
 +  - First, you have to choose a place on your computer, where the repository will be saved and at that place, open the command line
 +  - As an example, we will use kicad-mlab repository: https://github.com/MLAB-project/kicad-mlab
 +  - From the page, download the path to the repository - web button "Clone or download".
 +  - It is necessary to switch the path to "Clone with SSH" in stead of "Clone with HTTPS”.  
 +  - In our case, the path is as follows: git@github.com:MLAB-project/kicad-mlab.git
 +  - Run the following command in the command line:
  
   git clone git@github.com:MLAB-project/kicad-mlab.git   git clone git@github.com:MLAB-project/kicad-mlab.git
  
  
-  - Následně můžeme být vyzváni k zadání hesla, které jsme si zvolili při generování SSH klíče.+  - You may be asked to provide a password you have chosen during the SSH key generation 
  
-== Stažení aktuální verze: ==+== Downloading the current version ==
  
-  - V místě uložení repozitáře je potřeba zadat v příkazové řádce následující příkaz:+  - In the folder (?? Na místě) with the saved repository, run the following command in the command line:
  
   git pull   git pull
  
  
-== Zjištění stavu aktuálnosti repozitáře ==+== Finding out whether the repository is up-to-date ==
  
   git status   git status
  
-Tento příkaz vypíše u jakých souborů došlo ke změně, nebo které byli přidány jako nové.+This command lists all the files that have been changed or added as new.
  
-== Přidání nového souboru, složky ==+== Adding new file or folder ==
  
-  git add název_souboru +  git add file_name 
      
-Po označení celé cesty z výpisu příkazů lze cestu vložit pomocí kliknutí na prostřední tlačítko myši. +After marking (?? Označit) the whole path from the command list of commands (?? výpis příkazů), the path can be inserted by clicking on the middle mouse button.  
-Pro přidání všech změn lze použít ```git add .```.+For submitting (?? Adding, přidání) all the changes, you can use ```git add .```.
                
-== Vytvoření commitu ==+== Creating a commit ==
  
-  git commit -m "Popis provedené změny"+  git commit -m “Description of the change"
  
-Po tomto příkazu je commit pouze v lokální kopii repozitáře. Aby se data odeslala na server je potřeba zadat následující příkaz.+After running the above-mentioned command, the commit is only in the local copy of the repository. For data to be sent to the server, see the next section.
  
-== Upload na server ==+== Upload to server ==
  
   git push    git push 
      
-Pro ověření, zda veškeré úkony proběhly v pořádku je dobré se podívat na výstup příkazu:+It is helpful to list the output of the following command, to see if all the operation were done correctly.
  
   git status   git status
  
-Ve výpisu by neměly být žádné položky, které jsme chtěli nahrát.     +The list should not contain any items that we wanted to upload.
              
    
-== Změna velikosti lokálního repozitáře ==+== Changing the size of the local repository ==
  
-Git si ve výchozím nastavení stahuje celý repozitář včetně veškeré historie úprav. Toto lze zamezit při stahování repozitáře pomocí parametru ```--depth=<pocet stazenych commitu>```+In its default setting, Git downloads the whole repository including all the edit history. This can be prevented during the repository download by including ```--depth=<pocet stazenych commitu>``` parameter.
  
   git clone <adresa_repozitare> --depth=1   git clone <adresa_repozitare> --depth=1
  
-Pokuď toto chcete aplikovat na existující kopii repozitáře, lze to provést následujícím postupem.+If you want to apply it onto an existing copy of the repository, you can use the following approach:
  
   git fetch --depth 2   git fetch --depth 2
   git reflog expire --expire=all --all   git reflog expire --expire=all --all
   git gc --prune=all   git gc --prune=all
- 
- 
- 
- 
- 
-  
  
  
 === Windows === === Windows ===
-[[https://tortoisegit.org/download/|TortoiseGit]] Pod operačním systémem Windows je možné stahovat pohodlně data z GitHub do počítače přes program [[cs:tortoisegit|TortoiseGit]].+[[https://tortoisegit.org/download/|TortoiseGit]]  
 +Under Windows OS, data from GitHub can be comfortably download via a [[en:tortoisegit|TortoiseGit]] programme. 
  
  
-===== Dokumentace vývoje =====+===== Documentation =====
  
-==== Textová dokumentace ====+==== Text documentation ====
  
-Veškeré textové dokumenty jsou v MLABu kódovány v UTF-8 někteří uživatelé ale požívají na editaci souborů windows a výsledkem je nekompatibilní soubor, který je třeba překódovat.+All MLAB text documents are UTF-8 coded. Some users however use Windows for editing files which may result in an incompatible file, which needs to be re-coded. 
  
-Převod kódování textových souborů.+Converting the coding of text files.
  
   iconv -f WINDOWS-1250 -t UTF-8 zprava.txt  -o zprava.txt   iconv -f WINDOWS-1250 -t UTF-8 zprava.txt  -o zprava.txt
Line 636: Line 632:
 === Dokuwiki === === Dokuwiki ===
  
-Dokuwiki je systém ve kterém běží tato dokumentace.+Dokuwiki is a system that runs the documentation.
  
-== Offline editace ==+== Offline editing ==
  
-Podstatné ale je, že je možné tuto dokumentaci editovat i offline, což se hodí zejména při cestování.+Documentation can be edited offline, which is a very useful feature that one can use e.g. during traveling. 
    
-K tomu je potřeba si na svém notebooku zprovoznit lokální instanci wiki. Tu si zprovozníme podle [[https://www.dokuwiki.org/install:ubuntu#alternative_easier_custom_installation|návodu na instalaci Dokuwiki pod Ubuntu]]. Data pak mezi oběma instancemi wiki synchronizujeme pomocí [[https://www.dokuwiki.org/plugin:sync|pluginu sync]], který naistalujeme na svojí lokální instanci wiki. Po první synchronizaci se serverovou wiki můžeme stránky lokálně offline editovat a změny následně nahrát na veřejnou wiki MLAB. +For offline editing to work, it is necessary to create a local wiki instance on your notebook. It can be done following a [[https://www.dokuwiki.org/install:ubuntu#alternative_easier_custom_installation| guide for Dokuwiki intallation for Ubuntu]]. 
 + 
 +Data between both wiki instances are synchronised with [[https://www.dokuwiki.org/plugin:sync|sync plugin]] that is installed on the local wiki instance. After the first synchronisation with the server wiki we can locally edit the site offline and subsequently upload the changes to the public MLAB wiki.
  
 === LaTeX === === LaTeX ===
en/tools.txt · Last modified: 2023/02/02 22:39 by kaklik