Skip to content

Commit 0aee8f7

Browse files
committed
README.md: Modify steps of Usage
This modifies the steps required to build and run the website on the local machine by suggesting not to use sudo in the command to install jekyll and bundler and prefer asdf-vm to install ruby. Closes #477
1 parent fa09436 commit 0aee8f7

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,26 @@ Why?
2929

3030
## Usage
3131

32-
To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands:
32+
### Dependencies
3333

34-
$ sudo gem install jekyll bundler
34+
1. Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS.
35+
2. Using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
36+
3. Install Jekyll
37+
38+
$ gem install jekyll bundler
39+
40+
### Clone and Run
41+
42+
Clone coala Projects repository
43+
3544
$ git clone https://github.com/coala/projects.git
45+
46+
Run coala Projects website
47+
3648
$ cd projects
3749
$ bundle install
3850
$ bundle exec jekyll serve
3951

40-
4152
Then you can simply go to either of the following addresses in your browser to access the site:
4253

4354
127.0.0.1:4000

0 commit comments

Comments
 (0)