Skip to content

Commit f1e35a8

Browse files
Fix CLA script (#9)
Fix Contributor License Agreement script Also removed the PowerPoint tutorials, which are available on the main website.
1 parent 2aefed0 commit f1e35a8

File tree

3 files changed

+35
-32
lines changed

3 files changed

+35
-32
lines changed

.github/workflows/cla.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
- name: "CLA Assistant"
1313
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'
1414
# Beta Release
15-
uses: contributor-assistant/github-action@v2.3.0
15+
uses: contributor-assistant/github-action@v2.6.1
1616
env:
1717
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1818
# the below token should have repo scope and must be manually added by you in the repository's secret
@@ -23,7 +23,7 @@ jobs:
2323
path-to-signatures: 'signatures/Autodesk/Individual/sydevs.json'
2424
path-to-document: 'https://github.com/Autodesk/CLA-Assistant-Test-Signatures/blob/master/CLA.md' # e.g. a CLA or a DCO document
2525
# branch should not be protected
26-
branch: 'master'
26+
branch: 'main'
2727
allowlist: user1,bot*
2828

2929
#below are the optional inputs - If the optional inputs are not given, then default values will be taken
@@ -39,4 +39,4 @@ jobs:
3939
#custom-pr-sign-comment: 'The signature to be committed in order to sign the CLA'
4040
#custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
4141
#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

README.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ The recommended way to use SyDEVS in a simulation project is to include the [lat
2020

2121
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.
2222

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`
2929

3030
### Building SyDEVS using GCC on Windows
3131

3232
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.
3333

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`
4040

4141
### Testing SyDEVS
4242

@@ -48,30 +48,33 @@ Note that the complete set of regression tests will only run if MSVC is used. If
4848

4949
### Generating the API documentation
5050

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:
5252

53-
- `doxygen doxygen.config`
53+
* `doxygen doxygen.config`
5454

5555
This will build the documentation in the [`doc`](doc) directory. To open the documentation:
5656

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.
5959

6060
You should update the documentation on a regular basis to keep it in sync with the code.
6161

62-
## Documentation
62+
### Releasing a new version of SyDEVS
6363

64-
### Website
64+
When releasing a new version of SyDEVS, remember to perform the following steps:
6565

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.
6772

68-
### PowerPoint
73+
## Documentation
6974

70-
There are three PowerPoint documents located in the [`doc`](doc) folder:
75+
### Website
7176

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.
7578

7679
### Examples
7780

src/sydevs/core/arraynd.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,15 @@ namespace sydevs {
112112
* // multidimensional array `other`.
113113
* ~~~
114114
*
115-
* Copying a multidimensional array shares the internal data by default. The
116-
* result of `operator[]` also shares data, and so does the `view` member
117-
* function. The `copy` member function performs a deep copy of a
118-
* multidimensional array so that no data is shared.
115+
* If the result of `operator[]` is assigned or copied to another array, that
116+
* new array will continue to share data with the original. The same applies to
117+
* the result of the `view` member function. The `copy` member function,
118+
* however, ensures that the internal data is copied rather than shared.
119119
*
120120
* ~~~
121121
* auto arr = array2d<int64>({2, 3}, {0, 1, 2, 3, 4, 5});
122122
*
123-
* auto arr2 = arr; // Shares data.
123+
* auto arr2 = arr; // Copies data.
124124
* auto arr3 = arr[range()][range()]; // Shares data.
125125
* auto arr4 = arr.view(); // Shares data.
126126
* auto arr5 = arr.copy(); // Copies data.

0 commit comments

Comments
 (0)