Skip to content

Commit

Permalink
Update project structure description.
Browse files Browse the repository at this point in the history
  • Loading branch information
ondrej33 committed Dec 15, 2024
1 parent be43095 commit c0ee6d4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ Sketchbook presents a way to design all these components and more.

Once you finish designing your sketch, you can run the state-of-the-art synthesis algorithms and symbolically compute all BNs consistent with your requirements. You can then sample individual BNs, or export the results for further analysis with libraries like [AEON.py](https://pypi.org/project/biodivine-aeon/).

#### Manual
#### Manual and tutorial

In the provided `manual.pdf`, we discuss the details regarding
- installation,
- editing BN sketches in Sketchbook,
- running BN inference in Sketchbook,
- format and syntax used.

We also provide an introduction to Sketchbook using a short video tutorial that you can find as `tutorial.mp4`.
This tutorial covers basics on how to edit an sketch and run the inference.
For more details and explanations, see the manual.

The installation is also summarized below, with an additional development guide.

#### Citation
Expand Down
1 change: 1 addition & 0 deletions project-docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ It is divided into sections describing:
We first list the most important components of the project repository, mainly various source folders and configuration files. After that, we add more details on how the Rust back-end code and also `data` folder are structured.

- `manual.pdf` | PDF manual describing tool's functionality, sessions, and various syntax/format details.
- `tutorial.mp4` | Brief video tutorial introducing the tool and its basic functionality.
- `vite.config.ts` | Configuration for the Vite build system (HTML/JS/CSS processing). Most stuff is generated by Tauri, there's just some extra code related to properly building UIKit and to declaring multiple entry points for different windows.
- `tsconfig.json` | Configuration for the TypeScript compiler. Generated by Tauri for now. Later we might want to make it a bit more restrictive.
- `package.json` and `package-lock.json` | List of `npm` dependencies (and its frozen variant). Mostly just Tauri, UIkit, Less, PostHTML, some packages with types declarations, and testing frameworks.
Expand Down

0 comments on commit c0ee6d4

Please sign in to comment.