Skip to content
This repository was archived by the owner on Jan 22, 2025. It is now read-only.

Commit de3c798

Browse files
committed
chore: readme
1 parent 27eff84 commit de3c798

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

README.md

+25-12
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
# PLEASE READ: This repo no longer contains the SPL program implementations
2+
3+
This repo still exists in archived form, feel free to fork any reference
4+
implementations it still contains.
5+
6+
See Agave, the Solana validator implementation from Anza: https://github.com/anza-xyz/agave
7+
8+
---
9+
110
<p align="center">
211
<a href="https://solana.com">
312
<img alt="Solana" src="https://i.imgur.com/IKyzQ6T.png" width="250" />
@@ -26,20 +35,24 @@ $ rustup update
2635
```
2736

2837
When building a specific release branch, you should check the rust version in `ci/rust-version.sh` and if necessary, install that version by running:
38+
2939
```bash
3040
$ rustup install VERSION
3141
```
42+
3243
Note that if this is not the latest rust version on your machine, cargo commands may require an [override](https://rust-lang.github.io/rustup/overrides.html) in order to use the correct version.
3344

3445
On Linux systems you may need to install libssl-dev, pkg-config, zlib1g-dev, protobuf etc.
3546

3647
On Ubuntu:
48+
3749
```bash
3850
$ sudo apt-get update
3951
$ sudo apt-get install libssl-dev libudev-dev pkg-config zlib1g-dev llvm clang cmake make libprotobuf-dev protobuf-compiler
4052
```
4153

4254
On Fedora:
55+
4356
```bash
4457
$ sudo dnf install openssl-devel systemd-devel pkg-config zlib-devel llvm clang cmake make protobuf-devel protobuf-compiler perl-core
4558
```
@@ -71,8 +84,8 @@ Start your own testnet locally, instructions are in the [online docs](https://do
7184

7285
### Accessing the remote development cluster
7386

74-
* `devnet` - stable public cluster for development accessible via
75-
devnet.solana.com. Runs 24/7. Learn more about the [public clusters](https://docs.solanalabs.com/clusters)
87+
- `devnet` - stable public cluster for development accessible via
88+
devnet.solana.com. Runs 24/7. Learn more about the [public clusters](https://docs.solanalabs.com/clusters)
7689

7790
# Benchmarking
7891

@@ -103,10 +116,10 @@ $ open target/cov/lcov-local/index.html
103116
```
104117

105118
Why coverage? While most see coverage as a code quality metric, we see it primarily as a developer
106-
productivity metric. When a developer makes a change to the codebase, presumably it's a *solution* to
107-
some problem. Our unit-test suite is how we encode the set of *problems* the codebase solves. Running
108-
the test suite should indicate that your change didn't *infringe* on anyone else's solutions. Adding a
109-
test *protects* your solution from future changes. Say you don't understand why a line of code exists,
119+
productivity metric. When a developer makes a change to the codebase, presumably it's a _solution_ to
120+
some problem. Our unit-test suite is how we encode the set of _problems_ the codebase solves. Running
121+
the test suite should indicate that your change didn't _infringe_ on anyone else's solutions. Adding a
122+
test _protects_ your solution from future changes. Say you don't understand why a line of code exists,
110123
try deleting it and running the unit-tests. The nearest test failure should tell you what problem
111124
was solved by that code. If no test fails, go ahead and submit a Pull Request that asks, "what
112125
problem is solved by this code?" On the other hand, if a test does fail and you can think of a
@@ -138,10 +151,10 @@ reader is or is working on behalf of a Specially Designated National
138151
(SDN) or a person subject to similar blocking or denied party
139152
prohibitions.
140153

141-
The reader should be aware that U.S. export control and sanctions laws prohibit
142-
U.S. persons (and other persons that are subject to such laws) from transacting
143-
with persons in certain countries and territories or that are on the SDN list.
144-
Accordingly, there is a risk to individuals that other persons using any of the
145-
code contained in this repo, or a derivation thereof, may be sanctioned persons
146-
and that transactions with such persons would be a violation of U.S. export
154+
The reader should be aware that U.S. export control and sanctions laws prohibit
155+
U.S. persons (and other persons that are subject to such laws) from transacting
156+
with persons in certain countries and territories or that are on the SDN list.
157+
Accordingly, there is a risk to individuals that other persons using any of the
158+
code contained in this repo, or a derivation thereof, may be sanctioned persons
159+
and that transactions with such persons would be a violation of U.S. export
147160
controls and sanctions law.

0 commit comments

Comments
 (0)