Skip to content

Commit

Permalink
docs: update README.md and docs/index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheTechsTech committed May 14, 2024
1 parent 3dea19d commit 5bdd08b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -731,7 +731,7 @@ int co_main(int argc, char **argv)
</tr>
</table>
### 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
Expand All @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -1014,7 +1014,7 @@ Coroutine scheduler exited
</pre>
</details>
### 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
Expand All @@ -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 .
```

Expand All @@ -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

Expand Down

0 comments on commit 5bdd08b

Please sign in to comment.