Skip to content

Commit 00449a2

Browse files
authored
Fix readme (#974)
1 parent 7852000 commit 00449a2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,16 @@ git clone https://github.com/rust-lang/docs.rs.git docs.rs
4646
cd docs.rs
4747
# Configure the default settings for external services
4848
cp .env.sample .env
49+
# Create the CRATESFYI_PREFIX directory
50+
mkdir -p ignored/cratesfyi-prefix/crates.io-index
4951
# Builds the docs.rs binary
5052
cargo build
5153
# Start the extenal services
5254
docker-compose up -d db s3
5355
# Build a sample crate to make sure it works
5456
# This sets up the docs.rs build environment, including installing the nightly
5557
# Rust toolchain. This will take a while the first time but will be cached afterwards.
56-
cargo run web build crate regex 1.3.1
58+
cargo run -- build crate regex 1.3.1
5759
# This starts the web server but does not build any crates.
5860
cargo run start-web-server
5961
```
@@ -158,13 +160,13 @@ cargo run -- build crate --local /path/to/source
158160

159161
```sh
160162
# Adds a directory into database to serve with `staticfile` crate.
161-
docker-compose run web database add-directory <DIRECTORY> [PREFIX]
163+
docker-compose run -- database add-directory <DIRECTORY> [PREFIX]
162164

163165
# Updates github stats for crates.
164166
# You need to set CRATESFYI_GITHUB_USERNAME, CRATESFYI_GITHUB_ACCESSTOKEN
165167
# environment variables in order to run this command.
166168
# You can set this environment variables in ~/.cratesfyi.env file.
167-
docker-compose run web database update-github-fields
169+
docker-compose run -- database update-github-fields
168170
```
169171

170172
If you want to explore or edit database manually, you can connect to the database

0 commit comments

Comments
 (0)