Skip to content

Commit

Permalink
add build instructions (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
Surendrajat authored Sep 24, 2023
1 parent a3e3c91 commit b0666e1
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ jobs:
publish_dir: ./_site
cname: cutter.re
force_orphan: true
exclude_assets: ".bundle,.sass-cache,Gemfile*,.gitignore,.github"
exclude_assets: ".bundle,.sass-cache,Gemfile*,.gitignore,.github,README.md"
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Cutter Website

### How to build

1. Install `ruby` following [official guide](https://www.ruby-lang.org/en/documentation/installation/).
2. Install essential build tools (`build-essential` for linux & `Xcode cmdline tools` for macOS).
3. Clone this repo:

`git clone --filter=blob:none https://github.com/rizinorg/cutter.re`
4. Run the following:
```sh
cd cutter.re
gem install bundler
bundle install
bundle exec jekyll serve
```
If all goes right, you should be able to access the site at http://127.0.0.1:4000/

> [!NOTE]
> [Cutter documentation](https://cutter.re/docs/) source resides in [cutter repo](https://github.com/rizinorg/cutter/tree/dev/docs) and can be built using [these instructions](https://cutter.re/docs/contributing/docs/building-docs.html) separately.

0 comments on commit b0666e1

Please sign in to comment.