Warning, /sdk/ktechlab/README.md is written in an unsupported language. File is not indexed.
0001 0002 KTechLab 0.50.0 0003 ============= 0004 0005 KTechLab is an IDE for microcontrollers and electronics. 0006 It supports circuit simulation, 0007 program development for microcontrollers and 0008 simulating the programmed microcontroller together with its application circuit. 0009 0010 Introduction 0011 ------------- 0012 0013 Resources 0014 ------------- 0015 - KTechLab is joining KDE, all of its assets will be available there. 0016 0017 - https://community.kde.org/Incubator/Projects/KTechLab 0018 0019 - current webpage: 0020 https://userbase.kde.org/KTechlab 0021 TODO better webpage at KDE 0022 0023 - repository browser at KDE (web based): 0024 https://commits.kde.org/ktechlab 0025 https://invent.kde.org/sdk/ktechlab 0026 0027 - source code repository at KDE (to be used with git): 0028 git@invent.kde.org:sdk/ktechlab.git 0029 0030 - bugtracker at KDE: 0031 https://bugs.kde.org/describecomponents.cgi?product=KTechLab 0032 0033 - mailing list at KDE: 0034 ktechlab-devel at KDE 0035 https://mail.kde.org/mailman/listinfo/ktechlab-devel 0036 Archives contain the messages from the old list, too 0037 0038 - on IRC, KTechLab developers regularly join the channel 0039 `#ktechlab`, on Libera Chat 0040 0041 - source code repositories: see Getting the source section, below 0042 0043 - KTechLab on github (will become deprecated) 0044 0045 - https://github.com/ktechlab 0046 0047 - https://github.com/ktechlab/ktechlab/wiki 0048 0049 - https://github.com/ktechlab/ktechlab 0050 - https://github.com/ktechlab/ktechlab-0.3 (archive only; merged into the above repoistory) 0051 - new commits will be always pushed to KDE Git, github will be a mirror only 0052 0053 - KTechLab on sourceforge (mostly deprecated; source code downloads are available) 0054 - wiki: 0055 http://ktechlab.sourceforge.net 0056 - project page: 0057 http://sourceforge.net/projects/ktechlab 0058 - project page for developers: 0059 http://sourceforge.net/projects/ktechlab/develop 0060 0061 - the official communucation channel is hosted at KDE; the mailing list on sourceforge will become deprecated; 0062 it is called ktechlab-devel 0063 - link to archives of the list: 0064 http://sourceforge.net/mailarchive/forum.php?forum_name=ktechlab-devel 0065 0066 0067 0068 Getting the source 0069 ------------------ 0070 0071 KTechLab's source code is located in a GIT repository. 0072 0073 Official repository is hosted at KDE; its location is at 0074 0075 git@invent.kde.org:sdk/ktechlab.git 0076 0077 - repository browser 0078 https://invent.kde.org/sdk/ktechlab 0079 0080 - for write access, see section Write access to KTechLab repository at KDE, below. 0081 0082 0083 Deprecated official repositories located on github; they mirror code from KDE, 0084 and also have branches named github/* for historical reference. 0085 For new code use the KDE Git. 0086 0087 - https://github.com/ktechlab/ktechlab 0088 - the master branch contains the latest tested development code, 0089 while other branches might contain untested/unstable code 0090 0091 - https://github.com/ktechlab/ktechlab-0.3 0092 - the port-0.3.8-kde4-v1 branch contains currently the latest code 0093 (at the time of origina writing; this branch has become master branch in KDE repositories) 0094 0095 0096 Other notable deprecated GIT repositories are located on sourceforge: 0097 0098 - main KTechLab repository (deprecated, use KDE Git): 0099 - `git://ktechlab.git.sourceforge.net/gitroot/ktechlab/ktechlab` 0100 - contains the contents of the previously used SVN repository 0101 0102 - developers' own repositories (deprecated, use KDE Git): 0103 - `git://ktechlab.git.sourceforge.net/gitroot/ktechlab/ktl-alonzotg` 0104 - `git://ktechlab.git.sourceforge.net/gitroot/ktechlab/ktl-j_ohny_b` 0105 - `git://ktechlab.git.sourceforge.net/gitroot/ktechlab/ktl-zoltan_p` 0106 - the master branch should have the same content as the 0107 official master branch from github 0108 - these repositories contain work-in-progress code, 0109 which is supposed to be merged in the master branch on github 0110 0111 Checking out from GIT can be performed with the following commands: 0112 0113 git clone git://github.com/ktechlab/ktechlab.git 0114 cd ktechlab 0115 0116 0117 Building and Running 0118 -------------------- 0119 0120 Required dependencies 0121 0122 - Qt5 -dev 0123 - cmake 0124 - glib -dev 0125 - Extra Cmake Modules (ECM) 0126 - KDE Frameworks 5 libraries -dev (at the time of writing: 0127 Config CoreAddons DocTools IconThemes I18n KDELibs4Support 0128 KIO Parts TextEditor TextWidgets WidgetsAddons 0129 WindowSystem XmlGui) 0130 0131 Optional dependencies 0132 0133 - GPSim -dev, for microcontroller support 0134 0135 0136 0137 In KDE Frameworks 5, all Makefiles in KDE projects are generated using CMake. 0138 After checking out the source (see Getting the source), 0139 here is how to compile and install KTechLab. 0140 CMkake is not a run-time dependency of KTechLab. 0141 0142 0143 1. By using a terminal, navigate to the top-level source-directory 0144 0145 2. Run the shell script `build-simple.sh`. 0146 This command compiles KTechLab into the directory `build-simple`, 0147 installs it into the directory `inst-simple` and 0148 sets up the user-specific settings (syscoca, mime database) for the 0149 current user. 0150 0151 sh build-simple.sh 0152 0153 3. Launch KTechLab by running the script `run-simple.sh` 0154 0155 sh run-simple.sh 0156 0157 KTechLab should start running at this point. 0158 If this simple method of launching KTechLab does not work, 0159 please contact the developers, because you have found a bug. 0160 0161 ## Running a build when the source/build/install directory has been moved 0162 0163 It the source directory has been moved, then the setup procedure has 0164 to be rerun. This is due to the fact that in the launch scripts of 0165 KTechLab, absolute directory paths are generated. 0166 The compilation step should be a lot faster than previously, because 0167 the source files have not been changed, so the existing build is 0168 just verified, not recreated. 0169 0170 sh build-simple.sh 0171 sh run-simple.sh 0172 0173 Developing with KDevelop 4 / 5 0174 -------------------------- 0175 0176 Just open/import the CMakeLists.txt project file. 0177 0178 0179 Write access to KTechLab repository at KDE 0180 ------------------------------------------ 0181 0182 Please read the KDE Git manual: 0183 0184 https://community.kde.org/Sysadmin/GitKdeOrgManual 0185 0186 You need: 0187 0188 1. KDE developer account; should be usable at `identity.kde.org` ; see 0189 https://community.kde.org/Infrastructure 0190 https://community.kde.org/Infrastructure/Get_a_Developer_Account 0191 0192 An SSH key should be registered at KDE and usable on your computer. 0193 0194 2. Set up git for usage with KDE Git Infrastructure 0195 https://community.kde.org/Infrastructure/Git 0196 https://techbase.kde.org/Development/Git/Configuration 0197 git config --global user.name <Your Real Name> 0198 git config --global user.email <Your identity.kde.org email> 0199 0200 cat ~/.gitconfig 0201 0202 [url "git://anongit.kde.org/"] 0203 insteadOf = kde: 0204 [url "git@git.kde.org:"] 0205 pushInsteadOf = kde: 0206 0207 3. Clone KTechLab repository; current location is temporary: 0208 git clone kde:scratch/padrah/ktechlab 0209 0210 Pushing should work with the URL rewrite rules from step 2. 0211 0212 0213 Porting to KF5 / Qt5 0214 -------------------- 0215 0216 See 0217 1. https://techbase.kde.org/ECM5/IncompatibleChangesKDELibs4ToECM 0218 2. https://community.kde.org/Frameworks/Porting_Notes 0219 3. https://api.kde.org/frameworks/index.html 0220 0221 Have fun with KTechLab!