From 5bdd08bf08af8d066398ea92a16a95581086c76d Mon Sep 17 00:00:00 2001 From: Lawrence Stubbs Date: Tue, 14 May 2024 15:53:38 -0400 Subject: [PATCH] docs: update README.md and docs/index.md --- README.md | 8 ++++---- docs/index.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 68cab92..8b96acb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # c-coroutine -[![windows & linux & macOS](https://github.com/symplely/c-coroutine/actions/workflows/ci.yml/badge.svg)](https://github.com/symplely/c-coroutine/actions/workflows/ci.yml)[![macOS](https://github.com/symplely/c-coroutine/actions/workflows/ci_macos.yml/badge.svg)](https://github.com/symplely/c-coroutine/actions/workflows/ci_macos.yml)[![armv7, aarch64, ppc64le](https://github.com/symplely/c-coroutine/actions/workflows/ci_qemu_others.yml/badge.svg)](https://github.com/symplely/c-coroutine/actions/workflows/ci_qemu_others.yml)[![riscv64 & s390x by ucontext .](https://github.com/symplely/c-coroutine/actions/workflows/ci_qemu.yml/badge.svg)](https://github.com/symplely/c-coroutine/actions/workflows/ci_qemu.yml) +[![windows & linux & macOS](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci.yml/badge.svg)](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci.yml)[![macOS](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_macos.yml/badge.svg)](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_macos.yml)[![armv7, aarch64, ppc64le](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_qemu_others.yml/badge.svg)](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_qemu_others.yml)[![riscv64 & s390x by ucontext .](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_qemu.yml/badge.svg)](https://github.com/zelang-dev/c-coroutine/actions/workflows/ci_qemu.yml) **c-coroutine** is a cooperative multithreading library written in C89. Designed to be simple as possible in usage, but powerfully enough in execution, easily modifiable to any need. It incorporates most asynchronous patterns from various languages. They all the same behaviorally, just syntax layout differences. @@ -223,7 +223,7 @@ typedef struct values_s C_API value_t co_value(void_t); ``` -The above is the **main** and most likely functions to be used, see [coroutine.h](https://github.com/symplely/c-coroutine/blob/main/include/coroutine.h) for additional. +The above is the **main** and most likely functions to be used, see [coroutine.h](https://github.com/zelang-dev/c-coroutine/blob/main/include/coroutine.h) for additional. > Note: None of the functions above require passing/handling the underlying `routine_t` object/structure. @@ -731,7 +731,7 @@ int co_main(int argc, char **argv) -### See [examples](https://github.com/symplely/c-coroutine/tree/main/examples) folder for more +### See [examples](https://github.com/zelang-dev/c-coroutine/tree/main/examples) folder for more ## Installation @@ -757,7 +757,7 @@ cmake --build . --config Debug/Release ## Contributing -Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create [Github Issues](https://github.com/symplely/c-coroutine/issues) for bugs and new features and comment on the ones you are interested in. +Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create [Github Issues](https://github.com/zelang-dev/c-coroutine/issues) for bugs and new features and comment on the ones you are interested in. ## License diff --git a/docs/index.md b/docs/index.md index 81c2d94..c545d4d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -223,7 +223,7 @@ typedef struct values_s C_API value_t co_value(void_t); ``` -The above is the **main** and most likely functions to be used, see [coroutine.h](https://github.com/symplely/c-coroutine/blob/main/include/coroutine.h) for additional. +The above is the **main** and most likely functions to be used, see [coroutine.h](https://github.com/zelang-dev/c-coroutine/blob/main/include/coroutine.h) for additional. > Note: None of the functions above require passing/handling the underlying `routine_t` object/structure. @@ -1014,7 +1014,7 @@ Coroutine scheduler exited -### See [examples](https://github.com/symplely/c-coroutine/tree/main/examples) folder for more +### See [examples](https://github.com/zelang-dev/c-coroutine/tree/main/examples) folder for more ## Installation @@ -1025,7 +1025,7 @@ The build system uses **cmake**, that produces _single_ **static** library store ```shell mkdir build cd build -cmake .. -DCMAKE_BUILD_TYPE=Debug/Release -DBUILD_TESTING=ON/OFF # use to build files examples folder +cmake .. -DCMAKE_BUILD_TYPE=Debug/Release -DBUILD_TESTING=ON/OFF # use to build files in examples folder cmake --build . ``` @@ -1034,13 +1034,13 @@ cmake --build . ```shell mkdir build cd build -cmake .. -D BUILD_TESTING=ON/OFF # use to build files examples folder +cmake .. -D BUILD_TESTING=ON/OFF # use to build files in examples folder cmake --build . --config Debug/Release ``` ## Contributing -Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create [Github Issues](https://github.com/symplely/c-coroutine/issues) for bugs and new features and comment on the ones you are interested in. +Contributions are encouraged and welcome; I am always happy to get feedback or pull requests on Github :) Create [Github Issues](https://github.com/zelang-dev/c-coroutine/issues) for bugs and new features and comment on the ones you are interested in. ## License