Skip to content

Commit 86914ee

Browse files
PioBeatPioBeat
committed
chore: docu
1 parent 582249f commit 86914ee

File tree

15 files changed

+103
-92
lines changed

15 files changed

+103
-92
lines changed

‎README.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Model and analyze system dynamics using **reaction rules** and **graph rewriting
4141
- Depth-first search (DFS)
4242
- Random exploration
4343
- Match-all / Match-first
44+
- Custom (Simulated Annealing, ...)
4445
- Automatic construction of **Labeled Transition Systems (LTS)**
4546
- **State predicates and logical connectors** for property checking
4647
- **Rule priorities** to control nondeterminism and execution order
@@ -177,7 +178,7 @@ composite.juxtapose(F).parallelProduct(H);
177178
The Bigraph Framework adds specific behavior superimposed upon this meta
178179
model. Meaning, the implementation-specific details are kept out from the metamodel.
179180

180-
## Installation & Setup
181+
## Installation & Setup of the Java Framework
181182

182183
> All parts of Bigraph Framework are available from the [Central Repository](https://central.sonatype.com/).
183184
@@ -233,16 +234,31 @@ compile "org.bigraphs.framework:bigraph-converter:2.3.5"
233234

234235
### Logging
235236

236-
This framework employs SLF4J as a facade for the log4j logging framework.
237+
Bigraph Framework employs SLF4J as a facade for the many logging frameworks.
237238

238239
Depending on your project setup, you may need to include the following libraries in your `pom.xml`/`build.gradle`.
239240

240241
For a bare Maven/Gradle project:
241242
```xml
243+
<!-- For example, use log4j-->
242244
<dependency>
243-
<groupId>org.slf4j</groupId>
244-
<artifactId>slf4j-log4j12</artifactId>
245-
<version>1.7.30</version>
245+
<groupId>org.slf4j</groupId>
246+
<artifactId>slf4j-log4j12</artifactId>
247+
<version>1.7.30</version>
248+
</dependency>
249+
250+
<!-- Or, use a no-operation (NOP) logger implementation -->
251+
<dependency>
252+
<groupId>org.slf4j</groupId>
253+
<artifactId>slf4j-nop</artifactId>
254+
<version>2.0.7</version>
255+
</dependency>
256+
257+
<!-- or, for example, the reload4j implementation (fork of log4j) -->
258+
<dependency>
259+
<groupId>org.slf4j</groupId>
260+
<artifactId>slf4j-reload4j</artifactId>
261+
<version>2.0.9</version>
246262
</dependency>
247263
```
248264

‎documentation/v2-docusaurus/docs/index.mdx‎

Lines changed: 46 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import TabItem from '@theme/TabItem';
1818

1919

2020
- **Stable**: <span class="badge badge-secondary" style={{backgroundColor: '#19c37d'}}>2.3.5</span>
21-
- Previous Stable Versions: `2.3.4`, `2.3.3`, `2.3.2`, `2.3.1`
21+
- Previous Stable Versions: `2.3.4`, `2.3.3`, `2.3.2`
2222

2323
:::info Migration `2.1.2` → `2.2.0`
2424
For refactor and upgrade instructions, please see the
@@ -98,6 +98,7 @@ Model and analyze system dynamics using **reaction rules** and **graph rewriting
9898
- Depth-first search (DFS)
9999
- Random exploration
100100
- Match-all / Match-first
101+
- Custom (Simulated Annealing, ...)
101102
- Automatic construction of **Labeled Transition Systems (LTS)**
102103
- **State predicates and logical connectors** for property checking
103104
- **Rule priorities** to control nondeterminism and execution order
@@ -116,7 +117,7 @@ Model and analyze system dynamics using **reaction rules** and **graph rewriting
116117
(via tracking maps)
117118

118119

119-
## Use / Install / Dependencies
120+
## Usage and Installation
120121

121122
Bigraph Framework is online available as Maven/Gradle dependency.
122123

@@ -133,10 +134,10 @@ To build the source by yourself, follow the [README.md](https://github.com/bigra
133134

134135
### Quick Start: Project Template
135136

136-
To get started using Bigraph Framework right away, download the Maven/Gradle-based Project Template
137+
To get started using Bigraph Framework right away, download the Maven/Gradle-based Project Template:
137138

138-
- [Starter Project Template using Bigraph Framework](https://www.bigraphs.org/software/bigraph-framework/download/Project-Skeleton-for-Bigraph-Framework.zip)
139139
- See <a href={`https://github.com/bigraph-toolkit-suite/Project-Skeleton-for-Bigraph-Framework`}>here</a> for the latest version on GitHub
140+
- [Starter Project Template using Bigraph Framework](https://www.bigraphs.org/software/bigraph-framework/download/Project-Skeleton-for-Bigraph-Framework.zip) (ZIP-Archive)
140141

141142
The README contained therein, describes how to compile and start an application.
142143

@@ -173,47 +174,50 @@ import * as myConstClass2 from "../src/components/BigraphRepositoryBlock";
173174

174175
### Logging Configuration
175176

176-
Bigraph Framework employs SLF4J as a facade for the log4j logging framework.
177+
Bigraph Framework employs SLF4J as a facade for the many logging frameworks.
177178

178-
Depending on your project setup, you may need to include the following libraries in your `pom.xml`:
179+
Depending on your project setup, you may need to include the following libraries in your `pom.xml`/`build.gradle`.
179180

181+
For a bare Maven/Gradle project:
180182
```xml
181-
<dependencies>
182-
<!-- For any Maven project in general -->
183-
<dependency>
184-
<groupId>org.slf4j</groupId>
185-
<artifactId>slf4j-api</artifactId>
186-
<version>2.0.9</version>
187-
</dependency>
188-
<!-- Use a no-operation (NOP) logger implementation -->
189-
<dependency>
190-
<groupId>org.slf4j</groupId>
191-
<artifactId>slf4j-nop</artifactId>
192-
<version>2.0.7</version>
193-
</dependency>
194-
<!-- or, for example, the reload4j implementation (fork of log4j) -->
195-
<dependency>
196-
<groupId>org.slf4j</groupId>
197-
<artifactId>slf4j-reload4j</artifactId>
198-
<version>2.0.9</version>
199-
</dependency>
200-
201-
<!-- When used within a Spring project -->
202-
<dependency>
203-
<groupId>org.springframework.boot</groupId>
204-
<artifactId>spring-boot-starter</artifactId>
205-
<exclusions>
206-
<exclusion>
207-
<groupId>org.springframework.boot</groupId>
208-
<artifactId>spring-boot-starter-logging</artifactId>
209-
</exclusion>
210-
</exclusions>
211-
</dependency>
212-
<dependency>
213-
<groupId>org.springframework.boot</groupId>
214-
<artifactId>spring-boot-starter-log4j2</artifactId>
215-
</dependency>
216-
</dependencies>
183+
<!-- For example, use log4j-->
184+
<dependency>
185+
<groupId>org.slf4j</groupId>
186+
<artifactId>slf4j-log4j12</artifactId>
187+
<version>1.7.30</version>
188+
</dependency>
189+
190+
<!-- Or, use a no-operation (NOP) logger implementation -->
191+
<dependency>
192+
<groupId>org.slf4j</groupId>
193+
<artifactId>slf4j-nop</artifactId>
194+
<version>2.0.7</version>
195+
</dependency>
196+
197+
<!-- or, for example, the reload4j implementation (fork of log4j) -->
198+
<dependency>
199+
<groupId>org.slf4j</groupId>
200+
<artifactId>slf4j-reload4j</artifactId>
201+
<version>2.0.9</version>
202+
</dependency>
203+
```
204+
205+
For Spring-based Projects:
206+
```xml
207+
<dependency>
208+
<groupId>org.springframework.boot</groupId>
209+
<artifactId>spring-boot-starter</artifactId>
210+
<exclusions>
211+
<exclusion>
212+
<groupId>org.springframework.boot</groupId>
213+
<artifactId>spring-boot-starter-logging</artifactId>
214+
</exclusion>
215+
</exclusions>
216+
</dependency>
217+
<dependency>
218+
<groupId>org.springframework.boot</groupId>
219+
<artifactId>spring-boot-starter-log4j2</artifactId>
220+
</dependency>
217221
```
218222

219223
Not including these dependencies will result in warnings.

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/AbstractBigraphMatcher.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/BigraphMatchingEngine.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/BigraphMatchingSupport.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/pure/PureBigraphMatch.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/pure/PureBigraphMatcher.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/pure/PureBigraphMatchingEngine.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/pure/PureMatchIteratorImpl.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2019-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2019-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

‎simulation/src/main/java/org/bigraphs/framework/simulation/matching/pure/PureReactiveSystem.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2021-2025 Bigraph Toolkit Suite Developers
2+
* Copyright (c) 2021-2026 Bigraph Toolkit Suite Developers
33
* Main Developer: Dominik Grzelak
44
*
55
* Licensed under the Apache License, Version 2.0 (the "License");

0 commit comments

Comments
 (0)