You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/cla.yml
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ jobs:
12
12
- name: "CLA Assistant"
13
13
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
14
14
# Beta Release
15
-
uses: contributor-assistant/github-action@v2.3.0
15
+
uses: contributor-assistant/github-action@v2.6.1
16
16
env:
17
17
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
18
18
# the below token should have repo scope and must be manually added by you in the repository's secret
path-to-document: 'https://github.com/Autodesk/CLA-Assistant-Test-Signatures/blob/master/CLA.md'# e.g. a CLA or a DCO document
25
25
# branch should not be protected
26
-
branch: 'master'
26
+
branch: 'main'
27
27
allowlist: user1,bot*
28
28
29
29
#below are the optional inputs - If the optional inputs are not given, then default values will be taken
@@ -39,4 +39,4 @@ jobs:
39
39
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
40
40
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
41
41
#lock-pullrequest-aftermerge: false - if you don't want this bot to automatically lock the pull request after merging (default - true)
42
-
#use-dco-flag: true - If you are using DCO instead of CLA
42
+
#use-dco-flag: true - If you are using DCO instead of CLA
Copy file name to clipboardExpand all lines: README.md
+27-24Lines changed: 27 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -20,23 +20,23 @@ The recommended way to use SyDEVS in a simulation project is to include the [lat
20
20
21
21
To build the SyDEVS examples and tests using [CMake](http://www.cmake.org/) and [Visual Studio 2022](https://www.visualstudio.com), follow the instructions below.
22
22
23
-
* Open a command prompt and navigate to the `sydevs` project directory.
24
-
*`mkdir build`
25
-
*`cd build/`
26
-
*`cmake -G "Visual Studio 17 2022" -A x64 ..`
27
-
* Open `build/SyDEVS.sln` in Visual Studio
28
-
* Recommendation: In `Tools -> Options -> Text Editor -> C/C++ -> Tabs`, select `Insert spaces` with a `Tab size` and `Indent size` of `4`
23
+
1. Open a command prompt and navigate to the `sydevs` project directory.
24
+
1.`mkdir build`
25
+
1.`cd build/`
26
+
1.`cmake -G "Visual Studio 17 2022" -A x64 ..`
27
+
1. Open `build/SyDEVS.sln` in Visual Studio
28
+
1. Recommendation: In `Tools -> Options -> Text Editor -> C/C++ -> Tabs`, select `Insert spaces` with a `Tab size` and `Indent size` of `4`
29
29
30
30
### Building SyDEVS using GCC on Windows
31
31
32
32
To build the SyDEVS examples and tests using [CMake](http://www.cmake.org/) and [TDM-GCC](https://jmeubank.github.io/tdm-gcc/), follow the instructions below.
33
33
34
-
* Install the 64+32-bit MinGW-w64 edition of TDM-GCC.
35
-
* Open a command prompt and navigate to the `sydevs` project directory.
36
-
*`mkdir bin`
37
-
*`cd bin/`
38
-
*`cmake -G "MinGW Makefiles" ..`
39
-
*`mingw32-make`
34
+
1. Install the 64+32-bit MinGW-w64 edition of TDM-GCC.
35
+
1. Open a command prompt and navigate to the `sydevs` project directory.
36
+
1.`mkdir bin`
37
+
1.`cd bin/`
38
+
1.`cmake -G "MinGW Makefiles" ..`
39
+
1.`mingw32-make`
40
40
41
41
### Testing SyDEVS
42
42
@@ -48,30 +48,33 @@ Note that the complete set of regression tests will only run if MSVC is used. If
48
48
49
49
### Generating the API documentation
50
50
51
-
To build or update the documentation files with [Doxygen](https://www.doxygen.nl/), make sure you are in the top level directory (where the `doxygen.config` is) and execute the following command:
51
+
To build or update the documentation files with [Doxygen](https://www.doxygen.nl/), make sure you are in the top level directory where [doxygen.config](doxygen.config) is located, and execute the following command:
52
52
53
-
-`doxygen doxygen.config`
53
+
*`doxygen doxygen.config`
54
54
55
55
This will build the documentation in the [`doc`](doc) directory. To open the documentation:
56
56
57
-
-`cd docs/html`
58
-
- Open `index.html` in your web browser.
57
+
1.`cd docs/html`
58
+
1. Open `index.html` in your web browser.
59
59
60
60
You should update the documentation on a regular basis to keep it in sync with the code.
61
61
62
-
##Documentation
62
+
### Releasing a new version of SyDEVS
63
63
64
-
### Website
64
+
When releasing a new version of SyDEVS, remember to perform the following steps:
65
65
66
-
The [Main SyDEVS Website](https://autodesk.github.io/sydevs) includes an [Overview](https://autodesk.github.io/sydevs/overview.html), a [Getting Started](https://autodesk.github.io/sydevs/getting_started/) tutorial, a [User Manual](https://autodesk.github.io/sydevs/user_manual/), and the [API Reference](https://autodesk.github.io/sydevs/doc/html/) for the latest release.
66
+
1. In [doxygen.config](doxygen.config), update the `PROJECT_NUMBER`.
67
+
1. Ensure the change above is merged into the `main` branch of the repo.
68
+
1. Create the new release.
69
+
1. Generate the API documentation, and copy the contents of `doc/html`.
70
+
1. Checkout the `gh-pages` branch of the repo.
71
+
1. In the `gh-pages` branch, replace the contents of `doc/html` with the contents copied above.
67
72
68
-
### PowerPoint
73
+
##Documentation
69
74
70
-
There are three PowerPoint documents located in the [`doc`](doc) folder:
75
+
### Website
71
76
72
-
-[`SyDEVS_Introduction.pptx`](doc/SyDEVS_Introduction.pptx): An introduction to the theory, paradigm, and code associated with SyDEVS.
73
-
-[`SyDEVS_Framework_Overview.pptx`](doc/SyDEVS_Framework_Overview.pptx): An overview of the systems modeling framework and related snippets of code.
74
-
-[`SyDEVS_Building7m_Tutorial.pptx`](doc/SyDEVS_Building7m_Tutorial.pptx): A tutorial that challenges developers to enhance the [`building7m`](src/examples/demo/building7m) example.
77
+
The [Main SyDEVS Website](https://autodesk.github.io/sydevs) includes an [Overview](https://autodesk.github.io/sydevs/overview.html), a [Getting Started](https://autodesk.github.io/sydevs/getting_started/) tutorial, a [User Manual](https://autodesk.github.io/sydevs/user_manual/), and the [API Reference](https://autodesk.github.io/sydevs/doc/html/) for the latest release.
0 commit comments