-
Notifications
You must be signed in to change notification settings - Fork 0
Introduction
The purpose of this documentation is to familiarize the student with how the Qt Mooc course works.
We will introduce the planned workflow as well as the tools and materials of the course.
After reading this documentation we expect the student to have correctly set up their working environment (Qt Creator, TMC) (Linux/Windows/Macintosh).
We also expect the student to have a sufficient understanding of Qt Coding convention.
We will include the available channels to ask for help (messenger/irc/telegram/pastebin) and instructions on how and when to use them.
Our goal is to present the student with the relevant information for them to be able to smoothly proceed into Week 1 and start working on the course.
What is Qt?
What is The Qt Company?
What is this course?
Why is this course?
Is this a course for beginners?
What are the requirements for enrolling in this course?
What do I need to know before enrolling in this course?
What are the goals of this course?
What is the schedule of this course?
What do I need to do to get credit for completing this course?
How do I get credit for this course after completing it?
What is the Qt Core?
What is the Qt Namespace?
What is Qt Creator?
What is Qmake?
What are shadow builds?
How does this all work?
What are .pro files?
What is TMC?
(What are kits?)
Where can I find the course material?
Where can I find the course exercises?
Where can I find documentation?
How do I set up my working environment?
Here we want to include sufficient instructions for the student to effortlessly set up their working environment (Linux/Windows/Macintosh). This part of the documentation could possibly benefit from being tested on actual people once it's done.
Qt Creator
Qt TMC plugin
Placeholder for download link to where the Qt TMC plugin is being distributed from.
The documentation above will need to be updated if/once the client side TMC plugin transitions from using TMC-cli to autotest.
How do I set up my working environment on my toaster? These instructions aren't helping me out.
How do I work on this course?
How do I complete assignments?
How should I write my code (coding conventions)?
Why adhere to coding conventions?
How do I use includes?
How do logging messages and alerts work?
How do I get help during the course?
Where do I find the right help for my particular issue?
- Technical problems with the course assignments
- Difficulties in figuring out assignments
- Stuck on code that doesn't work
- Technical problems with the course tools
- Technical problems with Qt/Qt Creator
- Problems/difficulties in making the course tools work before proceeding into Week 1 (WE WANT TO PREVENT AS MUCH AS POSSIBLE OF THIS INSTANCE OF A PROBLEM)
Here we will list all the possible contact channels a student may need with possible problems regarding the course.
We will also introduce pastebin as we are planning on using pastebin as a mean of displaying your code to peers when asking for help.
The general idea is that the course would have a contact channel where students enrolled on the course can ask for help.
Pastebin functionality should be implemented in a manner so that a student can copy their code and easily present it on messenger/telegram/irc). Which contact channel the course will be using needs to be figured out at some point.
(Do we include the contact channels from "Finding the answers" slide from Qt Essentials slide set?)
TBA
It seems like links such as the namespace page (http://doc.qt.io/qt-5/qt.html) could be useful to put together in a more or less exhaustive list that would be easy for the student to refer to when needed?