Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
refvalue committed Nov 16, 2024
1 parent d446e8a commit 4062ce5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 8 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@



## ⌨Under Development
![](assets/header.gif)

This open-source project is currently under development, with the author focusing on completing and improving unit tests to ensure code correctness. Please note that this README is unstable and may change at any time until the first version is released. I really appreciate your contributions through GitHub issues in this area.


## ℹA NEW RELEASE COMING SOON!

This open-source project is currently under development, with the author focusing on completing and improving unit tests to ensure code correctness. Please note that this README is unstable and may change at any time until the first version is released. I really appreciate your contributions through GitHub issues in this area.

❤Consider forking this repo or upstream if you like this project! Big thanks!



Expand Down Expand Up @@ -38,11 +44,11 @@ the [Release](http://www.baidu.com) page. After obtaining the compressed files,
location on your disk.

```powershell
Expand-Archive -Path './cpp-essence-1.0-windows-x86_64-release.zip' -DestinationPath 'C:\path\to\extract\folder'
Expand-Archive -Path './cpp-essence-0.1.0-windows-amd64-release.zip' -DestinationPath 'C:\path\to\extract\folder'
```

```bash
tar -zxf ./cpp-essence-1.0-linux-x86_64.tgz
tar -zxf ./cpp-essence-0.1.0-linux-amd64.tgz
```

Then you need to modify the `CMakeUserPresets.json` file in your own project to add a CMake variable which stores the
Expand All @@ -56,21 +62,21 @@ path of the directory that the file was decompressed to. Here is an example:
"name": "windows-debug-user",
"inherits": "windows-debug",
"cacheVariables": {
"ES_CPP_ESSENCE_ROOT": "E:/Libs/cpp-essence-1.0-windows-x86_64-debug"
"ES_CPP_ESSENCE_ROOT": "E:/Libs/cpp-essence-0.1.0-windows-amd64-debug"
}
},
{
"name": "windows-release-user",
"inherits": "windows-release",
"cacheVariables": {
"ES_CPP_ESSENCE_ROOT": "E:/Libs/cpp-essence-1.0-windows-x86_64-release"
"ES_CPP_ESSENCE_ROOT": "E:/Libs/cpp-essence-0.1.0-windows-amd64-release"
}
},
{
"name": "linux-release-user",
"inherits": "linux-release",
"cacheVariables": {
"ES_CPP_ESSENCE_ROOT": "/opt/cpp-essence-1.0-linux-x86_64"
"ES_CPP_ESSENCE_ROOT": "/opt/cpp-essence-0.1.0-linux-amd64"
}
}
]
Expand Down
Binary file added assets/header.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion include/essence/net/sse_client.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ namespace essence::net {
ES_API(CPPESSENCE) void on_message(const sse_message_handler& handler) const;

/**
* @brief Registers a error callback.
* @brief Registers an error callback.
* @param handler The error callback.
*/
ES_API(CPPESSENCE) void on_error(const error_handler& handler) const;
Expand Down

0 comments on commit 4062ce5

Please sign in to comment.