-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation and licensing info in README.md (#64)
### Summary Rephrase the documentation section in the README now that the docs.rs stuff is semi-useful. Also add some bits on how to run the examples since I think that's going to be a decent place to look at code going forward and I expect to add more examples. Add a section regarding the license at the bottom. I'm not sure if the GPLv3 is super popular and folks may not expect it, so worth pointing out. ### Motivation README.md was lagging a bit behind the project. ### Test Plan Spell check in CI
- Loading branch information
1 parent
7eee627
commit 8407ac9
Showing
3 changed files
with
29 additions
and
7 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,6 +25,7 @@ | |
"proto", | ||
"protobuf", | ||
"protos", | ||
"rustdocs", | ||
"snapshotting", | ||
"struct" | ||
], | ||
|
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
[package] | ||
name = "examples_ping-pong" | ||
name = "examples_ping_pong" | ||
version = "0.0.0" | ||
publish = false | ||
edition = "2021" | ||
|
||
[dependencies] | ||
busan = { path = "../../"} | ||
log = "0.4" | ||
env_logger = "0.10" | ||
env_logger = "0.10" |