Skip to content

Commit 3c2055e

Browse files
committed
doc
1 parent 44fbd28 commit 3c2055e

4 files changed

Lines changed: 7 additions & 191 deletions

File tree

docs/doc/en/_Footer.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/doc/en/_Sidebar.md

Lines changed: 0 additions & 67 deletions
This file was deleted.

docs/doc/en/index.md

Lines changed: 5 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Documentation
1+
## Introduction
22
Welcome to the QualCoder wiki!
33

44
The wiki covers instructions to install and use the QualCoder qualitative data analysis software. THe information here refers to the most recent version of QualCoder.
55

6-
## What is QualCoder?
6+
### What is QualCoder?
77
QualCoder is free, open source software for qualitative data analysis.
88
With QualCoder you can code text, images, audio and video, write journal notes and memos. You can categorise codes into a tree-like hierarchical categorisation scheme. Coding for audio and video requires the VLC media player.
99
Coder comparison reports can be generated for text coding using the Cohen’s Kappa statistic. A graph displaying codes and categories can be generated to visualise the coding hierarchy. Most reports can be exported as html, open document text (ODT) or as plain text files.
@@ -14,7 +14,7 @@ QualCoder is designed to be used as client-based software to be used by one pers
1414

1515
QualCoder is written by an Australian developer in python 3 using Qt for the graphical interface. A Sqlite database is used to store the coding data. There is also a Wordpress site for QualCoder at https://qualcoder.wordpress.com/.
1616

17-
## Why use QualCoder?
17+
### Why use QualCoder?
1818
**Qualcoder is free of charge.** Many qualitative analysis software requiring expensive one-time fees or monthly subscriptions. Not everyone can afford expensive fees.
1919

2020
**QualCoder is easy to use.** It has all you need to perform qualitative analysis without the complicated interfaces of some alternatives.
@@ -37,11 +37,11 @@ QualCoder is written by an Australian developer in python 3 using Qt for the gra
3737

3838
**QualCoder is a software option to support open science. [UNESCO recommendations on open science](https://www.unesco.org/en/open-science?hub=686)
3939

40-
## Wiki in other languages
40+
### Wiki in other languages
4141

4242
[Wiki in Français](https://qualcoder-fr.frama.io/)
4343

44-
## Collaboration on a Qualcoder project
44+
### Collaboration on a Qualcoder project
4545

4646
[Page on how to work as a team with QualCoder](https://github.com/ccbogel/QualCoder/wiki/2.4.-Working-in-a-Team)
4747

@@ -51,119 +51,3 @@ QualCoder is written by an Australian developer in python 3 using Qt for the gra
5151
<a href="https://www.buymeacoffee.com/ccbogelB" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
5252

5353
_5.3_
54-
55-
# Setup
56-
## QualCoder Installation and running instructions
57-
58-
### INSTALLATION
59-
60-
For the manual installations (using the command line or terminal) I mention a specific release version, for example version 3.6. Please check on the [releases page](https://github.com/ccbogel/QualCoder/releases) for the most current version, as it may be newer.
61-
62-
#### Prerequisites
63-
VLC is optional, but you will need it installed if you need to do any audio/video coding. Optionally, install ffmpeg for speech to text and waveform display, see https://phoenixnap.com/kb/ffmpeg-windows..
64-
65-
#### Windows
66-
67-
See [https://github.com/ccbogel/QualCoder/releases/3.7](https://github.com/ccbogel/QualCoder/releases/3.7)
68-
69-
You have two options for executables, created on Windows 11, and may work on Windows 10:
70-
71-
- There is a Windows installer on the release page called: **QualCoder.Win.3.7.exe**
72-
73-
- There is a standalone, non-installable exe folder called: **QualCoder.Win.3.7.Portable.zip** Download and unzip. It is in a folder alongside an internal folder. These both must be together or the exe will not run. Double-click the QualCoder exe to run, it takes up to 20 seconds to start.
74-
75-
Standalone, portable version: <img width="100" height="60" alt="QualCoder portable" src="https://github.com/user-attachments/assets/6be1de98-8b47-4d57-b4b5-c34375e44959" />
76-
77-
On first use of the exe, Windows may ask you to allow to run QualCoder. This is because it is from an unknown publisher. It costs a lot of money to get a trusted publisher certificate - so that will not be possible for the foreseeable future. If you are uncomfortable with these warnings install from the source as detailed next.
78-
79-
Alternatively, install from source code:
80-
81-
Download the source code. Read and apply the section for Windows source code usage in the **Readme.md** file.
82-
Remove the back ticks that surround the command line instructions ` as these are used for display only.
83-
84-
#### MacOS
85-
86-
**Install from App bundles:**
87-
88-
Make sure you have installed any MAC OS updates before starting the installation. Go to the System Settings app on your Mac. Click General in the sidebar (you may need to scroll down), then click Software Update.
89-
90-
Install QualCoder: Double-click the downloaded dmg-file. Drag QualCoder into the link to your applications.
91-
92-
Start QualCoder from your Launchpad or by double-clicking the app within your applications folder.
93-
We are currently not able to sign the app bundles, so when you first try to run the program, you may get a pop-up warning that QualCoder is from an unregistered developer or "QualCoder can't be opened because Apple cannot check it for malicious software." Depending on your processor, you may see one of these:
94-
95-
If you see "Show in Finder" or OK. Click Ok.
96-
97-
If you see "Done" or "Move to trash. Click "Done.
98-
99-
Next, go to Settings and select Privacy and Security. Scroll down until you see a message stating QualCoder was prevented from starting. Click on "open anyway". You may be prompted to enter your password and may need to click "Open" again. After entering your password, just wait for the program to open up. It may take several seconds.
100-
101-
From now on, QualCoder should start without issues.
102-
103-
**Install from source code:**
104-
105-
Download the source code. Read and apply the section for masOC source code usage in the **Readme.md** file.
106-
Remove the back ticks that surround the command line instructions ` as these are used for display only.
107-
108-
109-
#### Debian/Ubuntu Linux
110-
111-
There is an executable file in the releases page for Ubuntu 24.04 for the 3.6 release. Download and double click to run.
112-
113-
Alternatively, run QualCoder from the source code:
114-
115-
Download the source code. Read and apply the section for Ubuntu source code usage in the **Readme.md** file.
116-
Remove the back ticks that surround the command line instructions ` as these are used for display only.
117-
118-
#### Fedora 43
119-
120-
These instructions are tested with QualCoder 3.7 on Fedora 43 with Python 3.12.12.
121-
122-
Install dependencies:
123-
124-
`sudo dnf install python3.12`
125-
126-
Set up QualCoder:
127-
128-
`cd ~/qualcoder # replace with appropriate location on your machine`
129-
130-
`python3.12 -m venv env`
131-
132-
`source env/bin/activate`
133-
134-
`python3.12 -m ensurepip`
135-
136-
`python3.12 -m pip install --upgrade pip`
137-
138-
`mkdir tmp`
139-
140-
`TMPDIR=./tmp python3.12 -m pip install -r requirements.txt`
141-
142-
`deactivate`
143-
144-
Usage:
145-
146-
`cd ~/qualcoder # replace with appropriate location on your machine`
147-
148-
`source env/bin/activate`
149-
150-
`cd src`
151-
152-
`python3.12 -m qualcoder`
153-
154-
#### Fedora 42
155-
156-
These instructions download the current source code directly from GitHub. Note: Fedora uses Wayland which may not work well with the Qt graphical interface. It is suggested you also install Xwayland.
157-
158-
Download the source code. Read and apply the section for Fedora source code usage in the **Readme.md** file.
159-
Remove the back ticks that surround the command line instructions ` as these are used for display only.
160-
161-
There may be problems with QualCoder working with audio / video in Fedora.
162-
163-
#### Arch/Manjaro Linux
164-
165-
Download the source code. Read and apply the section for Arch source code usage in the **Readme.md** file.
166-
Remove the back ticks that surround the command line instructions ` as these are used for display only.
167-
168-
169-

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ plugins:
1010
nav:
1111
- Home: index.md
1212
- News: news/index.md
13-
- 'Documentation' : doc.md
14-
- 'English':
13+
- Documentation : doc.md
14+
- English:
1515
- doc/en/index.md
1616
- 'Home': doc/en/Home.md
1717
- '2.1.-Installation': doc/en/2.1.-Installation.md

0 commit comments

Comments
 (0)