Skip to content

Commit 08f93a6

Browse files
author
ajvazjan
committed
contribution docs + user and dev guides +2
1 parent 58c84b7 commit 08f93a6

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ asyncio.run(main(), loop_factory=puring.PuringLoop)
4545
### Also you can watch examples inside `docs/examples` and run them under ASAN with
4646
> make run-examples
4747
48+
## Benchmarks
49+
4850
## Installation
4951
#### Warning! Linux only
5052
Puring requires linux kernel version 5.19 and Python 3.12 or greater.
@@ -67,12 +69,12 @@ Run tests under ASAN:
6769
While working with code, dont forget to
6870
> make lint
6971
70-
#### Watch more commands inside `Makefile`. Currently tested only on Fedora 43 with 7.1.5 kernel version.
72+
#### Watch more commands in [developer guide](docs/DEVELOPMENT.md) or inside `Makefile`. Currently tested only on Fedora 43 with 7.1.5 kernel version.
7173

7274
## Architecture
7375
### io_uring
7476
Puring is written natively in CPython and brings the new event loop, based on io_uring. \
75-
What is io_uring and how it works, explained for Python developers - [here](docs/IO_URING.md)
77+
What is io_uring and how it works, explained shortly by us - [here](docs/IO_URING.md)
7678

7779
### Presenting new objects
7880
- Main:
@@ -114,9 +116,6 @@ Structure of this project is trying to be simple - we have pure c-layer and pure
114116

115117
To read about implementation details, go to [architecture page](docs/ARCHITECTURE.md)
116118

117-
118-
## Benchmarks
119-
120119
## Contributing
121120
We are looking for help with:
122121
1. Propose new features. You can choose something from our [roadmap](docs/ROADMAP.md) - you can add new checks yourself, but create an issue first.

0 commit comments

Comments
 (0)