Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ ConcBugDect-Rust is a Petri-net-based static analyzer for Rust concurrency bugs.

The crate name is `conc_bug_detector`. The installed binaries remain `pn` and `cargo-pn` (`cargo pn`).

A static English lesson for the Petri net, the three bug patterns, and the pipeline lives in [`web/`](web/README.md). GitHub Pages uses branch `main` and folder `/web`.

## Features

- Deadlock detection (`--mode deadlock`, the default).
Expand Down Expand Up @@ -205,6 +207,7 @@ This repository is a single Cargo package (not a workspace).
| `detect.sh` | Batch helper for analyzing crates under a directory. |
| `bench/` | Deadlock, data-race, and atomicity-violation benchmark crates. |
| `docs/` | Design notes (e.g. CFG→Petri control-flow completeness). |
| `web/` | Static explainer site (GitHub Pages folder `/web`). |

## Known limitations

Expand Down
Empty file added web/.nojekyll
Empty file.
21 changes: 21 additions & 0 deletions web/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Kaiwen Zhang

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
29 changes: 29 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Explainer site

Static lesson for ConcBugDect-Rust. It shows one Petri net firing, then deadlock, data race, and atomicity violation on small nets, then the analysis pipeline and where translation, the `unipn` library, and the detectors sit.

No build step. From the repository root:

```bash
python3 -m http.server -d web 8080
```

Open `http://127.0.0.1:8080/`. Opening `web/index.html` in a browser also works.

## GitHub Pages

The site is served only after this folder is on the default branch and Pages is turned on. A pull request branch does not publish it.

In the repository on GitHub: **Settings → Pages → Build and deployment**

- Source: **Deploy from a branch**
- Branch: **`main`**
- Folder: **`/web`**

Save. The project URL is `https://kevindadi.github.io/ConcBugDect-Rust/`.

`web/.nojekyll` is present so Pages serves the files as written.

## License

MIT. Copyright (c) 2025 Kaiwen Zhang. See [LICENSE](LICENSE).
Loading
Loading