Browse Source

Reorganizing README.md

Luiserebii 1 year ago
parent
commit
36f302b8c0
Signed by: Luiserebii <luis@serebii.io> GPG Key ID: 525A84BC981B7D3E
2 changed files with 15 additions and 4 deletions
  1. 13
    4
      README.md
  2. 2
    0
      docs/README.md

+ 13
- 4
README.md View File

@@ -4,8 +4,16 @@
4 4
 
5 5
 A minimal test framework for x86 ASM (32-bit).
6 6
 
7
+## Installation
8
+Running `make` will create a `libmintx86asm32.so` library to link against in the `build/` directory. For static linking, `build/` should be populated also with the respective `.o` object files needed.
9
+
7 10
 ## Usage
8
-Mint-x86asm32 exposes the following functions for use in testing:
11
+Using Mint is simple. The basic flow of a test program using Mint:
12
+
13
+1. Call assertions.
14
+2. Return with `test_end()` to clean up by calling it and forwarding the return value as the exit code.
15
+
16
+Mint exposes the following functions for use in testing:
9 17
 ```c
10 18
 test_assert(int32_t cond, char* title)
11 19
 test_assert_true(int32_t cond, char* title)
@@ -25,6 +33,10 @@ test_end()
25 33
 ```
26 34
 This library follows the C calling convention, and each function expects arguments on the stack to process and clean up correctly.
27 35
 
36
+## Documentation
37
+
38
+Documentation can be found by checking the [`docs/`](docs) directory.
39
+
28 40
 ## Expected output
29 41
 
30 42
 The general formatting of each function follows these patterns:
@@ -62,9 +74,6 @@ string.h
62 74
 [FAIL] 10 tests failing with 2 tests passing.
63 75
 ```
64 76
 
65
-## Building
66
-Running `make` will create a `.so` library to link against in the `build/` directory. For static linking, `build/` should be populated also with the respective `.o` object files needed.
67
-
68 77
 ## Testing
69 78
 Run `make && ./a.out` in the `test/` directory to test, which will run through functions and produce reasonable output.
70 79
 

+ 2
- 0
docs/README.md View File

@@ -0,0 +1,2 @@
1
+# Mintx86asm32 API
2
+

Loading…
Cancel
Save