Repository navigation
docs(example): add README for example/simple-server (issue #275) - #368
Merged
gg582 merged 1 commit intoOct 13, 2026
Merged
Conversation
Member
|
Thanks for your pull request! I'll merge it after completing #367 😄 Also, please take a look at recent issues about performance and CWIST v4 preparation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a README to
example/simple-server, which was listed in issue #275 as one of the directories without documentation.What it does: describes the three routes the server registers (
GET /,GET /health,POST /echo), shows the build command (make -C example/simple-server) and how to exercise each endpoint with curl, and includes a clean target.How it was verified: the Makefile and main.c in that directory were read to confirm route names, port (8080), binary name (
simple_server), and the build invocation. The README describes the code as it exists in the tree.What it does not do: does not add READMEs for any other example directory.