Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
M
mruby
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Libraries
mruby
Commits
ad37ddd8
Commit
ad37ddd8
authored
Sep 24, 2012
by
Daniel Bovensiepen
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Improve documentation for Gem and add limitations
parent
96afe4ba
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
17 additions
and
4 deletions
+17
-4
doc/mrbgems/README.md
doc/mrbgems/README.md
+17
-4
No files found.
doc/mrbgems/README.md
View file @
ad37ddd8
...
@@ -25,7 +25,7 @@ The folder *mrblib* contains pure Ruby files to extend mruby. The folder *src*
...
@@ -25,7 +25,7 @@ The folder *mrblib* contains pure Ruby files to extend mruby. The folder *src*
contains C files to extend mruby. The folder
*test*
contains pure Ruby files
contains C files to extend mruby. The folder
*test*
contains pure Ruby files
for testing purposes which will be used by mrbtest. The
*Makefile*
contains
for testing purposes which will be used by mrbtest. The
*Makefile*
contains
rules to build all C files and integrates them into the normal mruby
rules to build all C files and integrates them into the normal mruby
build process.
+README.md+ is a short description for the
Gem.
build process.
*README.md*
is a short description of your
Gem.
## C Extension
## C Extension
...
@@ -36,12 +36,12 @@ files to libmruby.a
...
@@ -36,12 +36,12 @@ files to libmruby.a
### Pre-Conditions
### Pre-Conditions
mrbgems will automatically call the
+gem-all+
make target of your Gem. Make
mrbgems will automatically call the
*gem-all*
make target of your Gem. Make
sure that you build all files in this target and that you add you object
sure that you build all files in this target and that you add you
r
object
files to libmruby.a
files to libmruby.a
mrbgems expects that you have implemented a C method called
mrbgems expects that you have implemented a C method called
*mrb_YOURGEMNAME_gem_init(mrb_state
*
mrb
)
*
. YOURGEMNAME will be replaced
*mrb_YOURGEMNAME_gem_init(mrb_state)*
. YOURGEMNAME will be replaced
by the name of you Gem. The directory name of your Gem is considered also
by the name of you Gem. The directory name of your Gem is considered also
as the name! If you call your Gem directory
*c_extension_example*
, your
as the name! If you call your Gem directory
*c_extension_example*
, your
initialisation method could look like this:
initialisation method could look like this:
...
@@ -104,3 +104,16 @@ process of your Ruby extension you can use the *Makefile* too.
...
@@ -104,3 +104,16 @@ process of your Ruby extension you can use the *Makefile* too.
|
|
+- README.md
+- README.md
```
```
## Current Limitations
The following limitations are currently existing:
*
Gem _MUST NOT_ have a
*src*
folder in case it doesn't have a
C extension
*
Gem _MUST NOT_ have a
*mrblib*
folder in case it doesn't have a
Ruby extension
*
Only Ruby files in the root directory of
*mrblib*
will be integrated
If you have ideas how to fix these issues without implementing to much
complexity into the code please provide your code or idea.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment