-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enhanced README.md with additional details and clarity
- Loading branch information
1 parent
cb6acfa
commit 5a3f615
Showing
1 changed file
with
39 additions
and
10 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 |
---|---|---|
@@ -1,22 +1,51 @@ | ||
```markdown | ||
# da-codec | ||
|
||
Scroll's DA encoding/decoding libraries. | ||
Scroll's DA (Data-Aware) encoding and decoding libraries provide efficient serialization and transmission mechanisms suitable for various applications in data handling. | ||
|
||
## Running unit tests | ||
``` | ||
## Getting Started | ||
|
||
To use the DA codec library in your project, follow these steps: | ||
|
||
1. Install Go on your machine if you haven't already: [Installing Go](https://golang.org/doc/install). | ||
2. Clone this repository: | ||
```bash | ||
git clone https://github.com/saintmoritzz/da-codec.git | ||
``` | ||
3. Navigate to the project directory: | ||
```bash | ||
cd da-codec | ||
``` | ||
4. Import the library in your Go project: | ||
```go | ||
import "path/to/your/da-codec" | ||
``` | ||
|
||
5. Use the encoding and decoding functions as needed in your application. | ||
|
||
## Running Unit Tests | ||
|
||
To ensure code integrity, run the following command: | ||
```bash | ||
go test -v -race ./... | ||
``` | ||
Make sure you have Go installed on your system. This command runs all tests in the project with verbose output and race condition detection. | ||
|
||
## FAQ | ||
|
||
**Q: Why the repo contains `libscroll_zstd*.a` binary files?** | ||
**Q: Why does the repo contain `libscroll_zstd*.a` binary files?** | ||
A: This simplifies package installation with `go get` without the need to perform additional steps for building the `libscroll_zstd*.a` files. | ||
|
||
A: This simplifies package installation with `go get` without the need to perform additional steps for building the `libscroll_zstd*.a`. | ||
**Q: Which platforms/architectures are supported?** | ||
A: `linux/amd64`, `linux/arm64`, `darwin/arm64`. Pull requests for other platforms/architectures are welcome. | ||
|
||
**Q: Which platforms/architectures are supported?** | ||
|
||
A: `linux/amd64`, `linux/arm64`, `darwin/arm64`. Pull requests for other platforms/architectures are accepted. | ||
**Q: I don't trust `libscroll_zstd*.a` binary files from the repo or these files don't work on my OS/ARCH. How can I rebuild them?** | ||
A: Run the following command if your OS/ARCH is supported: | ||
```bash | ||
cd libzstd && make libzstd | ||
``` | ||
|
||
**Q: I don't trust `libscroll_zstd*.a` binary files from the repo or these files don't work on my OS/ARCH. How to rebuild them?** | ||
## Contributing | ||
|
||
A: Just run `cd libzstd && make libzstd` if your OS/ARCH is supported. | ||
We welcome contributions to the `da-codec` library! If you have suggestions for improvements or find bugs, please feel free to open an issue or submit a pull request. Ensure you follow the coding standards and include relevant tests for your changes. | ||
``` |