Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Improve the setup description of the README file #42

Open
CrsiX opened this issue May 31, 2021 · 1 comment
Open

Improve the setup description of the README file #42

CrsiX opened this issue May 31, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@CrsiX
Copy link
Collaborator

CrsiX commented May 31, 2021

For some users it might be obvious how to use our test suite, but others might have problems with it. For example, the Windows-specific setup description is just as short as:

This has to be executed in the command line, run as administrator:

$ mklink /J \path\to\src\tests \path\to\repository\tests

Besides the fact that on Windows there are no paths that start with a "drive-less" \ but C:\ or D:\ instead, we need a much better and possible longer description for this. Of course, this would also apply to the *nix/BSD/MacOS part, which is just a ln call without further explanation.

Parts of this issue may be tracked in certain Zulip threads as well.

@CrsiX CrsiX added the documentation Improvements or additions to documentation label May 31, 2021
@N0W0RK N0W0RK self-assigned this May 31, 2021
@AntonKluge
Copy link
Contributor

How it also works and what might be easier for some: right-click on the Projekt -> Open Module Settings -> Modules -> Add Content Root -> Choose the corresponding Folder -> Mark as Tests Source -> Apply.
It's not as elegant but works pretty simple without the command line.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants