Add Readme

.gitignore

@@ -1,3 +1,4 @@
 /compare_venv
+/public
 /target
 profile.json

Cargo.toml

@@ -6,6 +6,7 @@ description = "virtualenv creation implemented in rust"
 repository = "https://github.com/konstin/gourgeist"
 license = "MIT OR Apache-2.0"
 keywords = ["virtualenv", "venv", "python"]
+readme = "Readme.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -38,6 +39,7 @@ opt-level = 3
 
 [profile.profiling]
 inherits = "release"
+lto = "thin"
 debug = true
 
 # The profile that 'cargo dist' will build with

Readme.md

@@ -0,0 +1,31 @@
+# Gourgeist
+
+Gourgeist is a rust library to create python virtual environments. It also has a CLI.
+
+## Rust
+
+```rust
+use camino::Utf8PathBuf;
+use gourgeist::{create_venv, get_interpreter_info, parse_python_cli};
+
+let location = cli.path.unwrap_or(Utf8PathBuf::from(".venv"));
+let python = parse_python_cli(cli.python)?;
+let data = get_interpreter_info(&python)?;
+create_venv(&location, &python, &data, cli.bare)?;
+```
+
+## CLI
+
+Use `python` as base for a virtualenv `.venv`:
+```bash
+gourgeist
+```
+
+Or use custom defaults:
+```bash
+gourgeist -p 3.11 my_env
+```
+
+## Jessie's gourgeist
+
+![Jessie's gourgeist, a pokemon with a jack o'lantern as body](static/gourgeist.png)

oranda.json

@@ -0,0 +1,5 @@
+{
+  "styles": {
+    "theme": "axo_light"
+  }
+}

src/main.rs

@@ -20,7 +20,7 @@ struct Cli {
 
 fn run() -> Result<(), gourgeist::Error> {
     let cli = Cli::parse();
-    let location = cli.path.unwrap_or(Utf8PathBuf::from(".venv-rs"));
+    let location = cli.path.unwrap_or(Utf8PathBuf::from(".venv"));
     let python = parse_python_cli(cli.python)?;
     let data = get_interpreter_info(&python)?;
     create_venv(&location, &python, &data, cli.bare)?;