Skip to content

Commit aa53c31

Browse files
committed
update README.md
1 parent 8d1f1ef commit aa53c31

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,31 @@
22

33
An experimental type-level Ruby interpreter for testing and understanding Ruby code.
44

5+
## Installation
6+
7+
Install via RubyGems.
8+
9+
```sh
10+
$ gem install typeprof
11+
```
12+
13+
### Requirements
14+
15+
TypeProf supports Ruby 3.3 or later.
16+
17+
## Quick start
18+
19+
1. Install VSCode [Ruby TypeProf](https://marketplace.visualstudio.com/items?itemName=mame.ruby-typeprof) extension: `code --install-extension mame.ruby-typeprof`
20+
2. Run `typeprof --init` in your project root to create `typeprof.config.jsonc` file.
21+
Other options are available. See [typeprof.conf.jsonc](typeprof.conf.jsonc) for details.
22+
23+
3. Reopen your project in VSCode.
24+
525
## Development
626

7-
1. Install Ruby 3.3 or later.
8-
2. Git clone this repository: `git clone https://github.com/ruby/typeprof.git`
9-
3. Install VSCode extension: `code --install-extension mame.ruby-typeprof`
10-
4. Open the repository in VSCode: `code typeprof`
27+
1. Git clone this repository: `git clone https://github.com/ruby/typeprof.git`
28+
2. Install VSCode [Ruby TypeProf](https://marketplace.visualstudio.com/items?itemName=mame.ruby-typeprof) extension: `code --install-extension mame.ruby-typeprof`
29+
3. Open the repository in VSCode: `code typeprof`
1130

1231
### Testing
1332

0 commit comments

Comments
 (0)