Skip to content

Commit

Permalink
Set rustc version in Cargo.toml & README (ordinals#1615)
Browse files Browse the repository at this point in the history
  • Loading branch information
apbendi authored and whoabuddy committed Feb 21, 2023
1 parent d20cc17 commit 248bd8e
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
`ord`
=====
# `ord`

`ord` is an index, block explorer, and command-line wallet. It is experimental
software with no warranty. See [LICENSE](LICENSE) for more details.
Expand All @@ -24,8 +23,7 @@ where the project is and where it's going.
Join [the Discord server](https://discord.gg/87cjuz4FYg) to chat with fellow
ordinal degenerates.

Wallet
------
## Wallet

`ord` relies on Bitcoin Core for private key management and transaction signing.
This has a number of implications that you must understand in order to use
Expand All @@ -50,8 +48,7 @@ versions of `ord`. To migrate, use `ord wallet send` from the old wallet to
send sats and inscriptions to addresses generated by the new wallet with `ord
wallet receive`.

Installation
------------
## Installation

`ord` is written in Rust and can be built from
[source](https://github.com/casey/ord). Pre-built binaries are available on the
Expand All @@ -66,8 +63,7 @@ curl --proto '=https' --tlsv1.2 -fsLS https://ordinals.com/install.sh | bash -s
Once `ord` is installed, you should be able to run `ord --version` on the
command line.

Building
--------
## Building

On Debian and Ubuntu, `ord` requires `libssl-dev` when building from source:

Expand All @@ -93,9 +89,7 @@ The default location for the `ord` binary once built is `./target/release/ord`.

`ord` requires `rustc` version 1.67.0 or later. Run `rustc --version` to ensure you have this version. Run `rustup update` to get the latest stable release.


Syncing
-------
## Syncing

`ord` requires a synced `bitcoind` node with `-txindex` to build the index of
satoshi locations. `ord` communicates with `bitcoind` via RPC.
Expand All @@ -108,8 +102,7 @@ If `bitcoind` is not on mainnet, is not run by the same user, has a non-default
datadir, or a non-default port, you'll need to pass additional flags to `ord`.
See `ord --help` for details.

Logging
--------
## Logging

`ord` uses [env_logger](https://docs.rs/env_logger/latest/env_logger/). Set the
`RUST_LOG` environment variable in order to turn on logging. For example, run
Expand All @@ -119,8 +112,7 @@ the server and show `info`-level log messages and above:
$ RUST_LOG=info cargo run server
```

New Releases
------------
## New Releases

Release commit messages use the following template:

Expand Down

0 comments on commit 248bd8e

Please sign in to comment.