Skip to content

Commit 62f11d3

Browse files
committed
docs: update readme
1 parent 0e3b640 commit 62f11d3

File tree

1 file changed

+55
-5
lines changed

1 file changed

+55
-5
lines changed

README.md

Lines changed: 55 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,58 @@ We use [Middleman](https://middlemanapp.com/) to generate static pages for deplo
1010

1111
This guide assumes that you use either RVM or Rbenv and have installed Ruby version specified in [Gemfile](./Gemfile).
1212

13-
1. `git clone [email protected]:asi-wroclaw/asi.wroclaw.pl.git`
14-
2. `cd asi.wroclaw.pl`
15-
3. `bundle install --jobs=$(nproc)`
16-
4. `bundle exec middleman`
17-
5. `xdg-open http://localhost:4567` (or open it manually in your browser)
13+
### Ruby setup
14+
15+
```
16+
rvm install <version>
17+
```
18+
19+
or
20+
21+
```
22+
rvm use <version>
23+
```
24+
25+
### Project setup
26+
27+
```
28+
git clone [email protected]:asi-wroclaw/asi.wroclaw.pl.git
29+
```
30+
31+
```
32+
cd asi.wroclaw.pl
33+
```
34+
35+
```
36+
bundle install --jobs=$(nproc)
37+
```
38+
39+
### Update setup
40+
41+
```
42+
gem install bundle_update_interactive
43+
```
44+
45+
## Development
46+
47+
```
48+
bundle exec middleman
49+
```
50+
51+
Use snippet below or open it manually in your browser:
52+
```
53+
xdg-open http://localhost:4567
54+
```
55+
56+
57+
### Building
58+
59+
```
60+
bundle exec middleman build
61+
```
62+
63+
### Updating
64+
65+
```
66+
bundle ui
67+
```

0 commit comments

Comments
 (0)