Skip to content

Commit

Permalink
Merge pull request #5969 from jbampton/docs-fix-grammar
Browse files Browse the repository at this point in the history
Fix grammar in `mruby-YOUR-bigint/TODO-HINT.md`
  • Loading branch information
matz committed Apr 5, 2023
2 parents 19a2145 + ebdb03b commit 730cbe7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions examples/mrbgems/mruby-YOUR-bigint/TODO-HINT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The file structure in this example is as follows:
+- mruby-YOUR-bigint/ <- Make this directory public if necessary.
| Change the name of copied directory.
|
+- TODO-HINT.md <- This file is currently viewing by you.
+- TODO-HINT.md <- You are currently viewing this file.
| Remove this from copied directory.
|
+- core/
Expand All @@ -21,19 +21,19 @@ The file structure in this example is as follows:
May be depended on by other GEMs.
```

Implementors of own bigints should copy below this directory to another directory and do the following:
Implementors of their own bigints should copy below this directory to another directory and do the following:

- Rewrite `spec.author`, `spec.license`, `spec.homepage` and `spec.summary` in `<gem-dir>/mrbgem.rake` file to those of your own implementors.
- Implement the respective functions in `<gem-dir>/core/bigint.c`.
- Define and use an object structure for `MRB_TT_BIGINT` type-tag.
It is recommended to use `mrb_static_assert_object_size()` to ensure that the size of the object structure is within 6 words.
It is recommended to use `mrb_static_assert_object_size()` to ensure that the size of the object structure is within six words.
- Delete this file from the destination of the copy.

If you wish to use it as an alternative to the `mruby-bigint` provided by mruby, please leave the GEM name in `<gem-dir>/mrbgem.rake` as it is.
This is an important factor when it is depended from other GEMs with `spec.add_dependency 'mruby-bigint'`.

The name of the top directory of GEM can be changed arbitrarily.
The name of the git repository can also be changed arbitrarily.
The name of the top directory of the GEM can be changed arbitrarily.
The name of the Git repository can also be changed arbitrarily.

Note that there is no need for an initialization function as there is in normal GEM.
Note that there is no need for an initialization function as there is in a normal GEM.
If you need it, create a file `<gem-dir>/src/bigint.c` for example, and implement the `mrb_mruby_bigint_gem_init()` function.

0 comments on commit 730cbe7

Please sign in to comment.