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: CONTRIBUTING.md
+22-7
Original file line number
Diff line number
Diff line change
@@ -69,8 +69,23 @@ Please make sure you have a github account before you start. Also we recommend t
69
69
70
70
-[Create a github account](https://github.com/join)
71
71
-[Add an RSA key to your github account](https://docs.github.com/en/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)
72
-
-[It's a good practice to protect your accoutn by adding 2 factors authentication](https://docs.github.com/en/github/authenticating-to-github/configuring-two-factor-authentication)
73
-
-[Join RISC OS Community, by filling up this form and give us your github account name and what type of contribution you would like to purse](https://paolozaino.wordpress.com/contact/)
72
+
-[It's a good practice to protect your account by adding 2 factors authentication](https://docs.github.com/en/github/authenticating-to-github/configuring-two-factor-authentication)
73
+
74
+
## How to join this community
75
+
To provide fixes and improvement to code, you do not necessarily need to join, however if you want to help by reviewing code or other more involved tasks or just be part of one of the team to quickly pick an issue to work on, you'll need to join the community.
76
+
77
+
To join, make sure you have your pre-requisites in place and then use the link [here](https://paolozaino.wordpress.com/contact/) to let us know you want to join.
78
+
79
+
In the request specify your github account username and which teams you would like to join between:
80
+
81
+
- Admin Team
82
+
- Code Reviews Team
83
+
- Dev Team
84
+
- Docs Team
85
+
- Graphics Design Team
86
+
- Audio Design Team
87
+
88
+
I you want, you can request to join multiple teams.
74
89
75
90
## Contributing to this project/repository
76
91
To contribute is fairly easy:
@@ -87,7 +102,7 @@ In general you'd want to:
87
102
- Create your branch using: `git branch -b branch-name`
88
103
- we suggest that you name your branches following this pattern: `your_nick-what_type_of_changes_you_are_applying` with no spaces, you can use either dash or underscore to your preference
89
104
* If instead you want to use Forking:
90
-
- Fork a repo from here to your guthub account. If you're not familiar with forking then [here there are useful info for you](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
105
+
- Fork a repo from here to your github account. If you're not familiar with forking then [here there are useful info for you](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo)
91
106
* Start adding your changes
92
107
- If you need on-line RISC OS documentation you can find it [here](https://www.riscosopen.org/wiki/documentation/show/HomePage)
93
108
- Where applicable stick to RISC OS Style guide
@@ -98,7 +113,7 @@ In general you'd want to:
98
113
-[Official Programmer Documentation from RISC OS Open](https://www.riscosopen.org/wiki/documentation/show/Programmer%20documentation)
99
114
- For changes that may require patching RISC OS Code or modifying RISC OS code in whatever form please also refer to the [Official Developer Documentation from RISC OS Open](https://www.riscosopen.org/wiki/documentation/show/Developer%20documentation)
100
115
- Make sure you keep the documentation and code comments up-to-date with your changes
101
-
* When done with your changes add them to your local git using: `git add ./what-you-chaged`
116
+
* When done with your changes add them to your local git using: `git add ./what-you-changed`
102
117
* Commit your changes using: `git commit -m "commit message"`
103
118
- Make sure your commit messages are clear and meaningful to help reviewers to understand what you were trying to achieve
104
119
- When possible try to make small commits and Pull Requests so that the review process can be quicker
@@ -108,15 +123,15 @@ In general you'd want to:
108
123
109
124
# Coding Style for C Developers
110
125
111
-
One of the best an dmost complete C Coding style guide is the Linux Kernel C Coding Style Guide. So, for all general C related coding you should follow such set of rules (learning it can also help you a lot in your Software Engineering career), here is the Linux Coding Style guide for you: [Linux Coding Style Guide](https://www.kernel.org/doc/html/v5.10/process/coding-style.html).
126
+
One of the best and most complete C Coding style guide is the Linux Kernel C Coding Style Guide. So, for all general C related coding you should follow such set of rules (learning it can also help you a lot in your Software Engineering career), here is the Linux Coding Style guide for you: [Linux Coding Style Guide](https://www.kernel.org/doc/html/v5.10/process/coding-style.html).
112
127
113
-
Given that RISC OS is not linux and has its own ToolBox you shall consider all colliding rules to be superseeded by the corresponding rule in the RISC OS Style Guide, here is a link to how to obtain it: [RISC OS Style Guide](https://www.riscosopen.org/wiki/documentation/show/Style%20Guide)
128
+
Given that RISC OS is not linux and has its own ToolBox you shall consider all colliding rules to be superseded by the corresponding rule in the RISC OS Style Guide, here is a link to how to obtain it: [RISC OS Style Guide](https://www.riscosopen.org/wiki/documentation/show/Style%20Guide)
114
129
115
130
Also please have a look at the Programming Conventions hosted on RISCOS.info, [click here to read them](http://www.riscos.info/index.php/Programming_Conventions)
116
131
117
132
ROOL DDE Compiler support C89 and C99 (and they started to add support for C11), so, if you need, [here](http://www.sourceformat.com/pdf/c-standard-international.pdf) you can find a good C99 standard guide (precisely the Committee Draft — May 6, 2005 ISO/IEC 9899:TC2) you can use as reference while coding.
118
133
119
-
If instead you prefer to use GCC, RISC OS has ative support for GCC 4 and the GCCSDK Project (building C code for RISC OS using GCC on Linux) support GCC 4, GCC 8 and they started to add GCC 10. You can fin dmor einfo on about this on [RISCOS.info](https://www.riscos.info/index.php/Cross-compiling_software_with_GCCSDK)
134
+
If instead you prefer to use GCC, RISC OS has native support for GCC 4 and the GCCSDK Project (building C code for RISC OS using GCC on Linux) support GCC 4, GCC 8 and they started to add GCC 10. You can find more info on about this on [RISCOS.info](https://www.riscos.info/index.php/Cross-compiling_software_with_GCCSDK)
RiscLua is a port to RISC OS of the Lua programming language. It differs from standard Lua in a few small details to be more conformant to RISC OS. The packaging of RiscLua has also varied. At one point it was a relocatable module, but it was found that error-handling was easier when packaged as an application.
3
+
4
+
Lua license is included [here](LICENSE)
5
+
6
+
Changes to Lua port for RISC OS are copyright Gavin Wraith and distributed under the same license as Lua original code (MIT license)
7
+
8
+
9
+
## Status:
10
+
```
11
+
RiscLua 86 (VFP)
12
+
Based on Lua 5.4.3
13
+
Compiler: GCC 4.7.4
14
+
Libraries: riscos, lpeg
15
+
Numbers: 64bit integers, 64bit vfp
16
+
package.path: rlua86:lib.?,?
17
+
package.cpath: rlua86:solib.?/so,?/so
18
+
date: 2021/09/18
19
+
```
20
+
21
+
For more info please click [here](http://www.wra1th.plus.com/lua/risclua.html)
0 commit comments