Skip to content

Commit

Permalink
doc fixes (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
Krastanov authored Jun 3, 2023
1 parent 92f2bc0 commit 4920751
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
7 changes: 6 additions & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# API
# API

```@autodocs
Modules = [ConcurrentSim]
Private = false
```
7 changes: 3 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ ConcurrentSim is a discrete-event process-oriented simulation framework written

The documentation contains a tutorial, topical guides explaining key concepts, a number of examples and the API reference. The tutorial, the topical guides and some examples are borrowed from SimPy to allow a direct comparison and an easy migration path for users. The differences between ConcurrentSim and SimPy are clearly documented.

`ConcurrentSim.jl` used to be known as `SimJulia.jl` until 2023. It is one of the longest-lived Julia packages.

## Example

A short example simulating two clocks ticking in different time intervals looks like this:
Expand Down Expand Up @@ -37,7 +39,4 @@ fast 0.5
slow 1.0
fast 1.0
fast 1.5
```


`ConcurrentSim.jl` is a fork of Ben Lauwens' `SimJulia.jl`.
```

4 comments on commit 4920751

@Krastanov
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error while trying to register: Register Failed
@Krastanov, it looks like you are not a publicly listed member/owner in the parent organization (JuliaDynamics).
If you are a member/owner, you will need to change your membership to public. See GitHub Help

@Krastanov
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/84829

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.0 -m "<description of version>" 49207515ae3f1eb22032a0ce8e4330d18e415cb0
git push origin v1.0.0

Please sign in to comment.