Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .clang-format
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ AllowAllArgumentsOnNextLine: 'false'
AllowAllConstructorInitializersOnNextLine: 'true'
AllowShortBlocksOnASingleLine: 'false'
AllowShortCaseLabelsOnASingleLine: 'false'
AllowShortFunctionsOnASingleLine: Empty
AllowShortFunctionsOnASingleLine: Inline
BinPackParameters: 'false'
BreakBeforeBinaryOperators: NonAssignment
BreakBeforeBraces: Attach
Expand Down
8 changes: 4 additions & 4 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
root = true

[examples/assembler/*.reqasm]
indent_style = tab
root = true
[examples/assembler/*.reqasm]
indent_style = tab
indent_size = 8
16 changes: 8 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.vscode

assembler/obj/**
vm/obj/**

# ignore binary files
*.exe
*.reqvm
.vscode
assembler/obj/**
vm/obj/**
# ignore binary files
*.exe
*.reqvm
46 changes: 23 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# Contributing guidelines

## Issues

When creating an issue to report a bug please include as much information as possible and make sure it's an actual bug in my code instead of one in your program. Include steps to reproduce the bug.

## Pull requests

Note that if you need to add new source files to either the assembler or the VM, you will not need to make any changes to the Makefiles, as they can find new files by themselves.

Do:

* submit code that uses C++17 features
* format your code using clang-format and the provided .clang-format file
* make sure to not cross the 72-column mark for each line in your commit messages

Do not:

* submit unformatted code
* write in C
* submit code that triggers compiler warnings or does not compile

Naming conventions: `snake_case` must be used for functions, names of types and namespaces. `CAPITAL_SNAKE_CASE` must be used for macros. Private variables must have their names starting with an underscore(`_`).
# Contributing guidelines
## Issues
When creating an issue to report a bug please include as much information as possible and make sure it's an actual bug in my code instead of one in your program. Include steps to reproduce the bug.
## Pull requests
Note that if you need to add new source files to either the assembler or the VM, you will not need to make any changes to the Makefiles, as they can find new files by themselves.
Do:
* submit code that uses C++17 features
* format your code using clang-format and the provided .clang-format file
* make sure to not cross the 72-column mark for each line in your commit messages
Do not:
* submit unformatted code
* write in C
* submit code that triggers compiler warnings or does not compile
Naming conventions: `snake_case` must be used for functions, names of types and namespaces. `CAPITAL_SNAKE_CASE` must be used for macros. Private variables must have their names starting with an underscore(`_`).
42 changes: 21 additions & 21 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License

Copyright (c) 2020 - present Mitca Dumitru

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License
Copyright (c) 2020 - present Mitca Dumitru
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# reqvm

reqvm is a bytecode virtual machine written as learning experience, there's probably some weird design choices, but I don't really care.

This repository also contains a basic assembler for the VM.

If you wish to build the project yourself, check out the [build instructions](documentation/build_instructions.md).

If you wish to contribute, check out the [contribution guidelines](CONTRIBUTING.md).

## Documentation

* [the specification document](documentation/specification.md)
* [the assembler syntax](documentation/assembler_syntax.md)

More documentation to come as I write it.

## Legal

The project is licensed under the MIT License, a copy of which is included [here](LICENSE.txt).

The project uses [magic_enum](https://github.com/Neargye/magic_enum/), which is licensed under the MIT License.
# reqvm
reqvm is a bytecode virtual machine written as learning experience, there's probably some weird design choices, but I don't really care.
This repository also contains a basic assembler for the VM.
If you wish to build the project yourself, check out the [build instructions](documentation/build_instructions.md).
If you wish to contribute, check out the [contribution guidelines](CONTRIBUTING.md).
## Documentation
* [the specification document](documentation/specification.md)
* [the assembler syntax](documentation/assembler_syntax.md)
More documentation to come as I write it.
## Legal
The project is licensed under the MIT License, a copy of which is included [here](LICENSE.txt).
The project uses [magic_enum](https://github.com/Neargye/magic_enum/), which is licensed under the MIT License.
Loading