Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Noor Wachid committed Dec 27, 2023
1 parent 693e634 commit c9e38f4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
25 changes: 13 additions & 12 deletions contributor.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Contributors

## Project Structures

### `binding`
Other language binding code, right now it only has JavaScript binding.
Contains code for language bindings. Currently, it only includes JavaScript binding.

### `editor`
Live-demo website code.
Code for the live-demo website.

### `source`
- `Gularen/`, publicly available APIs
- `Gularen/Internal/`, should not be used in consumer source code.
- `Gularen/`: Publicly available APIs
- `Gularen/Internal/`: Should not be used in consumer source code.

### `spec`
Specification documents.
Expand All @@ -18,14 +19,14 @@ Specification documents.
Test units.

## Naming Convention
- Tab as indentation
- Always attach braces on the same line
- `macro` has to be written in `SCREAMING_SNAKE_CASE`
- `namespace`, `class` and `enum` has to be written in `PascalCase`
- `function`, `variable`, `enum.field` and others has to be written in `camelCase`
- Use a tab for indentation.
- Always attach braces on the same line.
- `macro` should be written in `SCREAMING_SNAKE_CASE`.
- `namespace`, `class`, and `enum` should be written in `PascalCase`.
- `function`, `variable`, `enum.field`, and others should be written in `camelCase`.

## Unit Test
I assume you are using Linux or MacOS.
Assuming you are using Linux or MacOS:

Create `build` directory and build the project, you will get `gularen-test` executable.
Run `sh test/run.sh` make sure all tests are passed.
Create a `build` directory and build the project; you will get the `gularen-test` executable.
Run `sh test/run.sh` to ensure all tests pass.
2 changes: 1 addition & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A sweet-spot of markup language
[Right over here](https://noorwach.id/gularen/editor/)

## CLI
[Right over here](cli/readme.md)
[Right over there](cli/readme.md)

## Contributors
[Please read](contributor.md)
Expand Down

0 comments on commit c9e38f4

Please sign in to comment.