-
Notifications
You must be signed in to change notification settings - Fork 2
Rewrite README: add overview, usage examples, and install instructions #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,109 @@ | ||
| # Safe Exam Browser for Linux | ||
| <div align="center"> | ||
| <img src="assets/icons/safe-exam-browser.png" alt="Safe Exam Browser for Linux logo" width="120" /> | ||
|
|
||
| Safe Exam Browser for Linux is a Qt 6 and Qt WebEngine based Linux desktop implementation focused on native startup, Linux desktop integration, and release packaging. | ||
| # Safe Exam Browser for Linux | ||
|
|
||
| It supports opening SEB configuration files, handling `seb://` and `sebs://` links, and running as an installed Linux desktop application. | ||
| A Linux-first desktop implementation of Safe Exam Browser, built with **Qt 6** and **Qt WebEngine**. | ||
| </div> | ||
|
|
||
| Prebuilt release files can be downloaded from GitHub Releases. | ||
| ## Overview | ||
|
|
||
| This project provides a native Linux client focused on: | ||
|
|
||
| - Reliable startup and kiosk-like exam runtime behavior | ||
| - Linux desktop integration (file associations and protocol handling) | ||
| - Packaging and distribution for common Linux ecosystems | ||
|
|
||
| It supports: | ||
|
|
||
| - Opening `.seb` configuration files | ||
| - Handling `seb://` and `sebs://` links | ||
| - Running as an installed Linux desktop application | ||
|
|
||
| > [!IMPORTANT] | ||
| > This repository is an independent Linux implementation and is **not** an official Safe Exam Browser release. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Make sure your environment has the dependencies required for a Qt 6 + Qt WebEngine desktop build. | ||
|
|
||
| ## Build | ||
|
|
||
| ```bash | ||
| ./scripts/build.sh | ||
| ``` | ||
|
|
||
| The compiled binary is written to: | ||
| Compiled binary output: | ||
|
|
||
| ```bash | ||
| build/bin/safe-exam-browser | ||
| ``` | ||
|
|
||
| ## Run | ||
|
|
||
| Start with default behavior: | ||
|
|
||
| ```bash | ||
| ./build/bin/safe-exam-browser | ||
| ``` | ||
|
|
||
| Open a local exam file: | ||
|
|
||
| ```bash | ||
| ./build/bin/safe-exam-browser /path/to/exam.seb | ||
| ``` | ||
|
|
||
| Open a remote exam link: | ||
|
|
||
| ```bash | ||
| ./build/bin/safe-exam-browser sebs://demo.safeexambrowser.org/exams/DemoExamGeneral.seb | ||
| ``` | ||
|
|
||
| Run with a JSON config file: | ||
|
|
||
| ```bash | ||
| ./build/bin/safe-exam-browser --config ./examples/minimal-config.json | ||
| ``` | ||
|
|
||
| ## Release Artifacts | ||
| ## Create Release Artifacts | ||
|
|
||
| ```bash | ||
| ./scripts/build-release.sh 0.1.0 | ||
| ``` | ||
|
|
||
| Artifacts are written to `dist/`. | ||
| Release files are written to `dist/`. | ||
|
|
||
| Published release downloads are available from the repository Releases page. | ||
| Prebuilt binaries are available from the GitHub Releases page. | ||
|
|
||
| ## Install | ||
| ## Installation | ||
|
|
||
| Debian-based systems: | ||
| ### Debian/Ubuntu | ||
|
|
||
| ```bash | ||
| sudo apt install ./dist/safe-exam-browser_0.1.0_amd64.deb | ||
| ``` | ||
|
|
||
| Arch Linux: | ||
| ### Arch Linux | ||
|
|
||
| ```bash | ||
| cd packaging/arch | ||
| makepkg -si | ||
| ``` | ||
|
|
||
| ## Notice | ||
| ## Contributing | ||
|
|
||
| Please review these files before opening a PR: | ||
|
|
||
| - [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
| - [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) | ||
| - [SECURITY.md](./SECURITY.md) | ||
|
|
||
| Quick copy/open helper: | ||
|
|
||
| ```bash | ||
| cat CONTRIBUTING.md CODE_OF_CONDUCT.md SECURITY.md | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| This repository is an independent Linux implementation and is not an official Safe Exam Browser release. | ||
| Licensed under the terms in `LICENSE`. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
# Safe Exam Browser for Linuxline is inside a block-level HTML<div>. In GitHub Flavored Markdown, Markdown isn’t parsed inside block HTML, so this will render as literal# ...text instead of an H1 heading. Consider using an HTML<h1>(and<p>for the tagline) or moving the Markdown heading outside the<div>while keeping the image centered.