Programátorská příručka - prihoada/NotEd GitHub Wiki
NotEd
Software vyvinutý v NetBeans IDE v rámci předmětu Softwarový projekt 1+2
Instalace aplikace NotEd
Systémové požadavky Program lze instalovat pouze na počítače s libovolným operačním systémem disponujícím technologií Java 7 JRE a vyšší. Příručku na instalaci této technologie naleznete na stránkách společnosti ORACLE https://www.oracle.com/java/index.html.
Postup instalace
Po stažení .zip souboru stačí tento archiv rozbalit na libovolné místo na disku. Spuštění se provede pro tyto operační systémy následovně:
Windows
Po rozbalení .zip archivu najdete v podsložce /bin spouštěcí soubor NotEd.exe, který je přímo určen pro platformu Windows. Tímto souborem program bez nutnosti žádné další instalace spustíte.
Unix (Ubuntu, OS X)
Po rozbalení .zip archivu najdete v podsložce /bin spouštěcí soubor noted.sh, který je přímo určen pro platformu Linux. Tímto souborem program bez nutnosti žádné další instalace spustíte.
Klonovaní projektu z Gitu
Klonování se provádí v příkazové řádce git Klonování existujícího repozitáře Repozitář naklonujete příkazem git clone [url].
`$ git clone https://github.com/prihoada/NotEd.git`
Tímto příkazem se vytvoří adresář s názvem NotEd, inicializuje se v něm adresář .git, stáhnou se všechna data pro tento repozitář a vytvoří se pracovní kopie nejnovější verze. Přejdete-li do nového adresářegrit, uvidíte v něm soubory projektu připravené ke zpracování nebo jinému použití. Pokud chcete naklonovat repozitář do adresáře pojmenovaného jinak než NotEd, můžete název zadat jako další parametr na příkazovém řádku:
`$ git clone https://github.com/prihoada/NotEd.git myNotEd`
Tento příkaz učiní totéž co příkaz předchozí, ale cílový adresář se bude jmenovat myNotEd.
Použité knihovny
· hamcrest-core-1.3 https://code.google.com/p/hamcrest/
· jMusic1.6.4 http://www.freshports.org/audio/jmusic
· junit-4.11 http://junit.org/
· proxymusic-3.0 https://proxymusic.kenai.com/xref/index.html
Konvence kódu
viz.:
https://github.com/prihoada/NotEd/wiki/Program%C3%A1torsk%C3%A9-konvence
http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
Jenkins
Kontinuální integrace (CI) spočívá v častém kompilování zdrojového kódu projektu, obvykle následovaném spuštěním testů.
Instalace a zprovoznění Jenkins:
http://www.abclinuxu.cz/blog/lojzoviny/2011/7/kontinualni-integrace-s-jenkins-ci
Testování
Pro testování je využita knihovna JUnit s nástavbou Hamcrest:
https://github.com/junit-team/junit/wiki/Download-and-Install
Testování v NetBeans
- vlastnosti projektu > zalozka sources > přidat složku tests do boxu Test Package
- zalozka libraries > karta Compile Tests > Add Library > JUnit 4.x
- spousteni vsech testu: alt-f6 nebo Run > Test project
Code coverage
plugin na code coverage TikiOne JaCoCoverage
- tools > plugins > available plugins > najít TikiOne JaCoCoverage