Skip to content

More readme updates #104

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
merged 2 commits into from
Oct 15, 2016
Merged

More readme updates #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09d61e8
More small updates to the README
alexcrichton Oct 14, 2016
20c1077
update the title as well
Oct 15, 2016
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
32 changes: 20 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
[![AppVeyor][appveyor]](https://ci.appveyor.com/project/japaric/rustc-builtins)
[![Travis][travis]](https://travis-ci.org/japaric/rustc-builtins)
# `compiler-builtins`

[appveyor]: https://ci.appveyor.com/api/projects/status/mofi55r3px9pv3o7?svg=true
[travis]: https://travis-ci.org/japaric/rustc-builtins.svg?branch=master

# `rustc-builtins`
[![Build status](https://ci.appveyor.com/api/projects/status/eusnjps5ui3d305p?svg=true)](https://ci.appveyor.com/project/rust-lang-libs/compiler-builtins)
[![Build Status](https://travis-ci.org/rust-lang-nursery/compiler-builtins.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/compiler-builtins)

> [WIP] Porting `compiler-rt` intrinsics to Rust

Expand All @@ -23,15 +20,26 @@ this crate ends up, as long as it's there):

``` toml
[dependencies]
rustc-builtins = { git = "https://github.com/japaric/rustc-builtins" }
compiler-builtins = { git = "https://github.com/rustc-lang-nursery/compiler-builtins" }
```

If you still get an "undefined reference to $INTRINSIC" error after that change, that means that we
haven't ported `$INTRINSIC` to Rust yet! Please open [an issue] with the name of the intrinsic and
the LLVM triple (e.g. thumbv7m-none-eabi) of the target you are using. That way we can prioritize
If you still get an "undefined reference to $INTRINSIC" error after that change,
that means that we haven't ported `$INTRINSIC` to Rust yet! Please open [an
issue] with the name of the intrinsic and the LLVM triple (e.g.
thumbv7m-none-eabi) of the target you are using. That way we can prioritize
porting that particular intrinsic.

[an issue]: https://github.com/japaric/rustc-builtins/issues
If you've got a C compiler available for your target then while we implement
this intrinsic you can temporarily enable a fallback to the actual compiler-rt
implementation as well for unimplemented intrinsics:

```toml
[dependencies.compiler-builtins]
git = "https://github.com/rustc-lang-nursery/compiler-builtins"
features = ["c"]
```

[an issue]: https://github.com/rust-lang-nursery/compiler-builtins/issues

## Contributing

Expand All @@ -45,7 +53,7 @@ porting that particular intrinsic.

[1]: https://github.com/rust-lang/compiler-rt/tree/8598065bd965d9713bfafb6c1e766d63a7b17b89/test/builtins/Unit
[2]: https://github.com/rust-lang/compiler-rt/tree/8598065bd965d9713bfafb6c1e766d63a7b17b89/lib/builtins
[3]: https://travis-ci.org/japaric/rustc-builtins
[3]: https://travis-ci.org/rust-lang-nursery/compiler-builtins

### Porting Reminders

Expand Down