Skip to content

Commit abe2039

Browse files
committed
docs: add emoji to README and improve quick setup
1 parent 2529d66 commit abe2039

1 file changed

Lines changed: 20 additions & 18 deletions

File tree

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,27 @@
1717

1818
</div>
1919

20-
## Why dtvem?
20+
## 🤔 Why dtvem?
2121

2222
Managing multiple versions of Python, Node.js, Ruby, and other runtimes across different projects is painful. Existing tools like `nvm`, `pyenv`, and `rbenv` work great on Unix systems but have limited or no Windows support. **dtvem** solves this by providing a single, unified tool that works seamlessly across all platforms.
2323

2424
### Key Features
2525

26-
- **Cross-Platform**: Windows, Linux, and macOS with identical behavior
27-
- **Multiple Runtimes**: Python, Node.js (Ruby, Go, and more coming)
28-
- **Shim-Based**: Automatic version switching without shell integration
29-
- **Migration Tool**: Import existing installations from nvm, pyenv, etc.
30-
- **Per-Directory Versions**: `.dtvem/runtimes.json` for project-specific versions
31-
- **No Shell Hooks**: Works in cmd.exe, PowerShell, bash, zsh, fish, etc.
26+
**Cross-Platform**: Windows, Linux, and macOS with identical behavior
27+
28+
**Multiple Runtimes**: Python, Node.js (Ruby, Go, and more coming)
29+
30+
**Shim-Based**: Automatic version switching without shell integration
31+
32+
**Migration Tool**: Import existing installations from nvm, pyenv, etc.
33+
34+
**Per-Directory Versions**: `.dtvem/runtimes.json` for project-specific versions
35+
36+
**No Shell Hooks**: Works in cmd.exe, PowerShell, bash, zsh, fish, etc.
3237

3338
See [Competitive Analysis](https://github.com/dtvem/dtvem/wiki/Competitive-Analysis) for how dtvem compares to nvm, pyenv, asdf, and mise.
3439

35-
## Installation
40+
## 📦 Installation
3641

3742
**macOS / Linux:**
3843
```bash
@@ -46,7 +51,7 @@ irm https://github.com/dtvem/dtvem/releases/latest/download/install.ps1 | iex
4651

4752
See [Installation Guide](https://github.com/dtvem/dtvem/wiki/Installation) for manual installation, building from source, and PATH configuration.
4853

49-
## Quick Start
54+
## 🚀 Quick Start
5055

5156
```bash
5257
# Install a runtime version
@@ -69,7 +74,7 @@ dtvem migrate python
6974

7075
See [Quick Start Guide](https://github.com/dtvem/dtvem/wiki/Quick-Start) for more examples.
7176

72-
## Documentation
77+
## 📚 Documentation
7378

7479
| Topic | Description |
7580
|-------|-------------|
@@ -83,7 +88,7 @@ See [Quick Start Guide](https://github.com/dtvem/dtvem/wiki/Quick-Start) for mor
8388
| [Competitive Analysis](https://github.com/dtvem/dtvem/wiki/Competitive-Analysis) | vs nvm, pyenv, asdf, mise |
8489
| [Roadmap](https://github.com/dtvem/dtvem/wiki/Roadmap) | Planned features and runtimes |
8590

86-
## Contributing
91+
## 🤝 Contributing
8792

8893
Contributions are welcome! See the [Development Guide](https://github.com/dtvem/dtvem/wiki/Development) for:
8994

@@ -96,20 +101,17 @@ Contributions are welcome! See the [Development Guide](https://github.com/dtvem/
96101
### Quick Setup
97102

98103
```bash
104+
# First, install dtvem (see Installation section above)
105+
# Then clone and set up the development environment:
99106
git clone https://github.com/dtvem/dtvem.git
100107
cd dtvem
101108
dtvem install # Install Node.js for git hooks
102109
npm install # Set up dev dependencies
103110
npm run check # Run format, lint, and tests
104111
```
105112

106-
### Areas for Contribution
107-
108-
- Add more runtime providers (Ruby, Go, Rust, Java)
109-
- Add shell completion scripts
110-
- Improve documentation
111-
- Write more tests
113+
Looking for something to work on? Check out [good first issues](https://github.com/dtvem/dtvem/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
112114

113-
## License
115+
## 📄 License
114116

115117
MIT License - See [LICENSE](LICENSE) file for details

0 commit comments

Comments
 (0)