Skip to content

Add readme to generated rustlings directory #2387

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

Open
senekor wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

Add readme to generated rustlings directory #2387

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions src/init.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,8 @@ pub fn init() -> Result<()> {
fs::write(".gitignore", GITIGNORE)
.context("Failed to create the file `rustlings/.gitignore`")?;

fs::write("README.md", README).context("Failed to create the file `rustlings/README.md`")?;

create_dir(".vscode").context("Failed to create the directory `rustlings/.vscode`")?;
fs::write(".vscode/extensions.json", VS_CODE_EXTENSIONS_JSON)
.context("Failed to create the file `rustlings/.vscode/extensions.json`")?;
Expand Down Expand Up @@ -220,6 +222,14 @@ target/
.vscode/
";

const README: &[u8] = b"# Rustlings

This is your space to solve Rustlings exercises.
Simply run `rustlings` in this directory to get started!
Learn more about using Rustlings here:
<https://rustlings.rust-lang.org/usage/>
";

pub const VS_CODE_EXTENSIONS_JSON: &[u8] = br#"{"recommendations":["rust-lang.rust-analyzer"]}"#;

const IN_INITIALIZED_DIR_ERR: &str = "It looks like Rustlings is already initialized in this directory.
Expand Down