Browse Source

Update README.md

master
Taylor Bockman 6 years ago committed by GitHub
parent
commit
1b9e172948
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 45
      README.md

45
README.md

@ -23,11 +23,13 @@ Small, fast code just isn't as important as it used to be. Still, it is a very i
6. [Section Names](#section-names) 6. [Section Names](#section-names)
7. [Variable Names](#variable-names) 7. [Variable Names](#variable-names)
8. [Functions](#functions) 8. [Functions](#functions)
9. [Function Prototypes](#function-prototypes) 9. [Macros](#macros)
10. [Section](#section) 10. [Function Prototypes](#function-prototypes)
11. [Type Declarations](#type-declarations) 11. [Section](#section)
12. [Alignment](#alignment) 12. [Type Declarations](#type-declarations)
13. [Project Organization](#project-organization) 13. [Alignment](#alignment)
14. [Project Organization](#project-organization)
15. [Mnemonics](#mnemonics)
## Getting Started ## Getting Started
@ -119,7 +121,7 @@ includelib \masm32\include\user32.lib
### Case Sensitivity ### Case Sensitivity
*Always* use the `option casemap:none` option. This prevents the assembler from thinking `MyFunction` is the same as *Always* use the `option casemap: none` option. This prevents the assembler from thinking `MyFunction` is the same as
`myfunction`, which will save you a lot of headaches. `myfunction`, which will save you a lot of headaches.
Example: Example:
@ -182,15 +184,29 @@ Example:
WinMain EndP WinMain EndP
``` ```
Additionally, place your functions toward the bottom of your code section. This keeps your actual code uncluttered, Additionally, place your functions toward the bottom of your code section, or in an include file.
and all of your functions in one easy-to-find place. This keeps your actual code uncluttered, and all of your functions in one easy-to-find place.
### Macros
Similar to functions, indent the body of the macro so it's easily differentiated from other code levels. To keep code uncluttered,
keep macros in an include file.
For macro "arguments", separate them like you would function arguments:
```asm
TEST macro x, y, z
;...
endm
```
### Function Prototypes ### Function Prototypes
In order to allow the use of functions at the bottom of your code, you need to declare function prototypes above In order to allow the use of functions at the bottom of your code, you need to declare function prototypes above
the invoking code. the invoking code.
Place prototypes after all includes, and leave two empty lines between the includes and prototypes. Place prototypes after all includes, and leave two empty lines between the includes and prototypes. Alternatively, store them in an
include file to keep them out of your main body of code entirely.
Example: Example:
@ -263,3 +279,14 @@ Example:
### Project Organization ### Project Organization
TODO TODO
### Mnemonics
When using assembly mnemonics, separate each argument with a space.
Example:
```asm
xor eax, eax
shl ebx, 8
```

Loading…
Cancel
Save