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: README.md
+18-60Lines changed: 18 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,87 +1,45 @@
1
1
2
-
# Frame Language Transpiler v0.11.0
2
+
# Frame Language Transpiler v0.11.5
3
3
4
-
This project contains the code for building the Frame Language Transpiler - the **Framepiler**. The Framepiler is written in Rust and transpiles Frame specification documents into Python (more languages to come) as well as
5
-
UML diagrams.
4
+
This project contains the code for building the Frame Language Transpiler - the **Framepiler**. The Framepiler is written in Rust and transpiles Frame specification documents into Python (with more languages to come) as well as UML Statechart diagrams.
6
5
7
-
## Frame Language Documentation
6
+
## Frame v0.11.5
8
7
9
-
To learn more about the Frame language, please find Frame's official documentation on [Read the Docs](https://docs.frame-lang.org).
8
+
Frame v0.11.5 has focused on stability, error handling and bug fixing. For details, see the [Release Notes](https://github.com/frame-lang/frame_transpiler/releases).
10
9
11
-
## New in Recent Releases
10
+
## Explore Frame
12
11
13
-
For details, see the [Release Notes](https://github.com/frame-lang/frame_transpiler/releases).
12
+
To learn more about the Frame language, please find Frame's official documentation on [Read the Docs](https://docs.frame-lang.org).
14
13
15
-
### Frame v0.11.0
16
-
17
-
Frame v0.11.0 brings a lot of exciting additions to the Frame language, adding both power and standardization to the notation. In addition, the transpiler now can read from stdin as well as still accepting file paths as in the past. This enables improved CI/CD processes involving Frame.
18
-
19
-
#### New Language Features and Updates
20
-
21
-
**Functions** -
22
-
23
-
With the introduction of functions to the Frame syntax, developers can now easily build simple Frame programs.
24
-
Currently the syntax only permits a single **main()** function. The **v0.12** will permit general
25
-
use of an unlimited number of functions.
26
-
27
-
See [Frame Functions](https://docs.frame-lang.org/en/latest/intermediate_frame/functions.html) for more information.
28
-
29
-
**System Controller Instantiation** -
30
-
31
-
With the introduction of Frame functions, developers can now create real Frame programs and instantiate
32
-
and control Frame systems. This capability allows for full control over system initialization of state
33
-
parameters, start state parameters and domain variables.
34
-
35
-
See [Frame Systems](https://docs.frame-lang.org/en/latest/intermediate_frame/systems.html#system-with-no-parameters).
36
-
37
-
**Operations** -
38
-
39
-
Frame operations are publicly accessible methods that bypass the state machine and allow privileged access to the
40
-
system domain data. In addition, operations can optionally be designated as **static**, enabling
41
-
systems to provide libraries of associated functionality for complex or repetitive system management routines.
42
-
43
-
See [Frame Operations](https://docs.frame-lang.org/en/latest/advanced_frame/operations.html)
44
-
45
-
**Enums** -
46
-
47
-
Frame now supports system enumerated types.
48
-
49
-
See [Frame Enumerated Types](https://docs.frame-lang.org/en/latest/intermediate_frame/enums.html).
50
-
51
-
**Loops** -
52
-
53
-
Frame now supports two types of loops:
54
-
55
-
1. For-like loops
56
-
2. Infinite loops
57
-
58
-
See [Frame Loops](https://docs.frame-lang.org/en/latest/intermediate_frame/loops.html).
14
+
## Tools and Resources
59
15
16
+
The Frame project is still early days but there are some resources and communities to help. You can download the [VSCode](https://marketplace.visualstudio.com/items?itemName=frame-lang-org.frame-machine-maker) extension to develop
17
+
Frame programs on your desktop or experiment with Frame online at the [Frame Playground](https://playground.frame-lang.org).
60
18
61
-
## Resources
19
+
You can also learn more about programming with automata at Reddit  on the [r/statemachines](https://www.reddit.com/r/statemachines/) subreddit (I'm the mod).
62
20
63
-
The Frame project is still early days but there are some resources and communities to help. You can download the [VSCode](https://marketplace.visualstudio.com/items?itemName=frame-lang-org.frame-machine-maker) extension to develop
64
-
Frame programs on your desktop or experiment with Frame online at the [Frame Playground](https://playground.frame-lang.org). You can learn more about the Frame language using the [online documentation ](https://docs.frame-lang.org) as well as find general resources about programming with automata at Reddit  on the [r/statemachines](https://www.reddit.com/r/statemachines/) subreddit.
21
+
## Frame Community
65
22
66
-
There is also a [Discord](https://discord.com/invite/CfbU4QCbSD) channel to connect with other Frame enthusiasts.
23
+
Connect with me and other Frame enthusists on the Frame **Discord channel** - [The Art of the State](https://discord.com/invite/CfbU4QCbSD). You can also connect with me directly on [LinkedIn](https://www.linkedin.com/in/marktruluck/).
67
24
68
-
###Frame Examples
25
+
## Frame Examples
69
26
70
27
The [Frame Solution Depot](https://github.com/frame-lang/frame_solution_depot) is a Github repo and contains a growing body of examples and test specifications.
71
28
72
29
## Reporting Bugs and Problems
73
30
74
-
For now please report issues to the [Gitter Bug Channel](https://gitter.im/frame-language/bug-reports) while we get a better system in place. If you have a recommendation please let me know there!
31
+
For now send issues to <[email protected]> while we get a better system in place. If you have a recommendation for a free bug tracker for open source communities please let me know!
32
+
75
33
76
34
## Getting Started
77
35
78
36
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
@@ -102,10 +60,10 @@ These instructions will get you a copy of the project up and running on your loc
102
60
2. Probably the same as MacOS but guessing you can figure it out if you know Linux and Rust. Still - please send me instructions on [Gitter Bug Channel](https://gitter.im/frame-language/bug-reports) and I will add to next release notes. Thanks!
2. Help needed. Please send me instructions on [Gitter Bug Channel](https://gitter.im/frame-language/bug-reports) and I will add to next release notes. Thanks!
107
66
108
-
109
67
## Built With
110
68
111
69
*[Rust](https://www.rust-lang.org/) - Rust language
@@ -120,7 +78,7 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
120
78
121
79
## Author
122
80
123
-
***Mark Truluck** - *Creator of Frame* - [LinkedIn](https://www.linkedin.com/in/marktruluck/)
81
+
**Mark Truluck** - *Creator of Frame* - [LinkedIn](https://www.linkedin.com/in/marktruluck/)
0 commit comments