Skip to content

Commit

Permalink
Move to Wiki.
Browse files Browse the repository at this point in the history
  • Loading branch information
finnbear committed Sep 24, 2024
1 parent c7a3290 commit 18a8919
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 53 deletions.
19 changes: 3 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,9 @@ let decoded: Foo<'_> = bitcode::decode(&encoded).unwrap();
assert_eq!(original, decoded);
```

## Adding Support for Other Libraries
## Adding Support for Libraries

See the instructions [here](/docs/ADDING_SUPPORT.md)!

## Tuple vs Array
If you have multiple values of the same type:
- Use a tuple or struct when the values are semantically different: `x: u32, y: u32`
- Use an array when all values are semantically similar: `pixels: [u8; 16]`
See the instructions [here](https://github.com/SoftbearStudios/bitcode/wiki/Adding-library-support)!

## Implementation Details
- Heavily inspired by <https://github.com/That3Percent/tree-buf>
Expand All @@ -52,15 +47,7 @@ If you have multiple values of the same type:
- Code is designed to be auto-vectorized by LLVM

## `serde`
A `serde` integration is gated behind the `"serde"` feature flag. It is slower, produces
slightly larger output, and (by extension) is not compatible with the native
`bitcode::{Encode, Decode}`. Note that:
- the `serde` version does not support types like
`serde_json::Value`, which internally serialize different types (numbers, arrays, etc.)
without a normal enum discriminant.
- the `serde` version omits
the `flowinfo` and `scope_id` fields of `std::net::SocketAddrV6`, but native `bitcode`
keeps them.
A `serde` integration is gated behind the `"serde"` feature flag. Click [here](https://github.com/SoftbearStudios/bitcode/wiki/Serde) to learn more.

## `#![no_std]`
All `std`-only functionality is gated behind the (default) `"std"` feature.
Expand Down
37 changes: 0 additions & 37 deletions docs/ADDING_SUPPORT.md

This file was deleted.

0 comments on commit 18a8919

Please sign in to comment.