Skip to content

Commit 8bfcd7e

Browse files
committed
Update README: add missing platforms, CI info, and fix typos
- Add win_arm (32-bit Windows ARM) to supported platforms list - Clarify that win_arm64 is 64-bit (not just 'experimental') - Specify Linux for AAPCS/AAPCS64 to distinguish from Windows ARM - Add Visual Studio version information (VS2017/VS2019/VS2022) - Add new Continuous Integration section explaining GitHub Actions - Mention that all 8 platforms are automatically built and tested - Fix typos: 'inlude' -> 'Include', 'assemby' -> 'assembly' - Improve formatting and clarity in static library section
1 parent ea1ed9e commit 8bfcd7e

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,17 +75,20 @@ calling convention, plus archive format:
7575

7676
- win_x86 (32 bits)
7777
- win_x64
78-
- win_ARM64 (experimental)
78+
- win_arm (32 bit ARM)
79+
- win_arm64 (64 bit ARM)
7980
- sysv_i386 (linux)
8081
- sysv_amd64 (linux)
81-
- AAPCS (32 bit arm)
82-
- AAPCS64 (64 bit arm)
82+
- AAPCS (32 bit arm - linux)
83+
- AAPCS64 (64 bit arm - linux)
84+
85+
All platforms are automatically built and tested by GitHub Actions CI on every commit.
8386

8487
### Supported toolchains:
8588

8689
- Gnu C
8790
- clang
88-
- Microsoft Visual Studio
91+
- Microsoft Visual Studio (VS2017, VS2019, VS2022)
8992

9093
Other platforms can be easily adapted from both existing implementations for other
9194
projects as well as from example code provided.
@@ -150,15 +153,27 @@ There are two basic ways to add the library to your project: Using a static libr
150153
151154
### static library (preferred)
152155
153-
- You link with the `libstackman.a` or `stackman.lib` libraries provided for your platform.
156+
- Link with the `libstackman.a` or `stackman.lib` libraries provided for your platform in the `lib/` directory.
157+
- Pre-built libraries are available for all supported platforms (8 ABIs total).
158+
- Libraries are automatically rebuilt by CI and committed to the repository for easy integration.
154159
155160
### inlined code
156161
157-
- You inlude `stackman_impl.h` in one of your .c source files to provide inline assembly.
158-
- You include `stackman_impl.h` in an assembly (.S) file in your project to include assembly code.
159-
- (windows) You include `stackman_s.asm` in an assemby (.asm) file in your project.
160-
In the case of inlined code, it can be specified to prefer in-line assembly and static linkage
161-
over separate assembly language source.
162+
- Include `stackman_impl.h` in one of your .c source files to provide inline assembly.
163+
- Include `stackman_impl.h` in an assembly (.S) file in your project to include assembly code.
164+
- (Windows) Include `stackman_s.asm` in an assembly (.asm) file in your project.
165+
166+
In the case of inlined code, it can be specified to prefer in-line assembly and static linkage
167+
over separate assembly language source.
168+
169+
## Continuous Integration
170+
171+
The project uses GitHub Actions to automatically:
172+
- Build libraries for all 8 supported platforms (Linux: AMD64, i386, ARM32, ARM64; Windows: x86, x64, ARM, ARM64)
173+
- Run test suites on all platforms (using QEMU emulation for ARM on Linux)
174+
- Commit updated libraries back to the repository on successful builds
175+
176+
See `.github/workflows/buildcommit.yml` for the complete CI configuration.
162177
163178
## Development
164179

0 commit comments

Comments
 (0)