Skip to content

docs: separate repository README #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alejandro-vaz merged 2 commits into from
Aug 28, 2026
Merged

docs: separate repository README #465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37ac598
docs: separate repository README
anisayakmitra-in Aug 28, 2026
8e5f252
docs: simplify repository README
anisayakmitra-in Aug 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .github/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Contributing to rust-smallvec

This branch contains the code for SmallVec v2, which is not yet ready for release.
If your code is using any of the alpha versions of SmallVec, be aware that the API
might change between versions.

The status of v2 can be tracked in:

- [the milestones](https://github.com/servo/rust-smallvec/milestones)
- [the wiki spec](https://github.com/servo/rust-smallvec/wiki)

The source code for the latest smallvec 1.x.y release can be found on the
[v1 branch](https://github.com/servo/rust-smallvec/tree/v1). Bug fixes for
smallvec v1 should be based on that branch, while new feature development should
go on the v2 branch.
14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,6 @@
rust-smallvec
=============

> [!IMPORTANT]
> This branch contains the code for SmallVec v2, which is not yet ready for release.
> If your code is using any of the alpha version of SmallVec, beware that the API might
> change between versions.
>
> The status of v2 can be tracked in:
> - [the milestones](https://github.com/servo/rust-smallvec/milestones)
> - [the wiki spec](https://github.com/servo/rust-smallvec/wiki)
>
> The source code for the latest smallvec 1.x.y release can be found on the
> [v1 branch](https://github.com/servo/rust-smallvec/tree/v1).
> Bug fixes for smallvec v1 should be based on that branch, while
> new feature development should go on the v2 branch.

## About smallvec

[Documentation](https://docs.rs/smallvec/)
Expand Down
Loading