From 0200740d70eddf029f786e92a4e905444be525f8 Mon Sep 17 00:00:00 2001 From: Jack May Date: Wed, 23 Jun 2021 14:22:35 -0700 Subject: [PATCH] Add sdk and program READMEs (#18154) (cherry picked from commit 94905dae52b6fc1865460e3bf53d89af9eb00258) --- sdk/Cargo.toml | 1 + sdk/README.md | 15 +++++++++++++++ sdk/program/Cargo.toml | 1 + sdk/program/README.md | 15 +++++++++++++++ 4 files changed, 32 insertions(+) create mode 100644 sdk/README.md create mode 100644 sdk/program/README.md diff --git a/sdk/Cargo.toml b/sdk/Cargo.toml index 8d2eeaa590..96e95b5e51 100644 --- a/sdk/Cargo.toml +++ b/sdk/Cargo.toml @@ -6,6 +6,7 @@ authors = ["Solana Maintainers "] repository = "https://github.com/solana-labs/solana" homepage = "https://solana.com/" documentation = "https://docs.rs/solana-sdk" +readme = "README.md" license = "Apache-2.0" edition = "2018" diff --git a/sdk/README.md b/sdk/README.md new file mode 100644 index 0000000000..da1a7e4a11 --- /dev/null +++ b/sdk/README.md @@ -0,0 +1,15 @@ +

+ + Solana + +

+ +# Solana SDK + +Use the Solana SDK Crate to write client side applications in Rust. If writing on-chain programs, use the [Solana Program Crate](https://crates.io/crates/solana-program) instead. + +More information about Solana is available in the [Solana documentation](https://docs.solana.com/). + +The [Solana Program Library](https://github.com/solana-labs/solana-program-library) provides examples of how to use this crate. + +Still have questions? Ask us on [Discord](https://discordapp.com/invite/pquxPsq) diff --git a/sdk/program/Cargo.toml b/sdk/program/Cargo.toml index 1dea17e81b..def452227c 100644 --- a/sdk/program/Cargo.toml +++ b/sdk/program/Cargo.toml @@ -6,6 +6,7 @@ authors = ["Solana Maintainers "] repository = "https://github.com/solana-labs/solana" homepage = "https://solana.com/" documentation = "https://docs.rs/solana-program" +readme = "README.md" license = "Apache-2.0" edition = "2018" diff --git a/sdk/program/README.md b/sdk/program/README.md new file mode 100644 index 0000000000..7f1335ebe5 --- /dev/null +++ b/sdk/program/README.md @@ -0,0 +1,15 @@ +

+ + Solana + +

+ +# Solana Program + +Use the Solana Program Crate to write on-chain programs in Rust. If writing client-side applications, use the [Solana SDK Crate](https://crates.io/crates/solana-program) instead. + +More information about Solana is available in the [Solana documentation](https://docs.solana.com/). + +[Helloworld](https://github.com/solana-labs/example-helloworld) and the [Solana Program Library](https://github.com/solana-labs/solana-program-library) provide examples of how to use this crate. + +Still have questions? Ask us on [Discord](https://discordapp.com/invite/pquxPsq)