diff --git a/README.md b/README.md index 0a19911..29c2ffa 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,57 @@ # BitcoinABC.org Website This is built using Github pages which uses Jekyll as a native static site framework. It was not necessary to install Jekyll to build this. It is simply a fork of an implementation of the "beautiful Jekyll" theme. Please refer upstream for helpful notes on using Jekyll and Github Pages. # Basic Install Instructions -Install rvm: https://rvm.io/rvm/install +## Install rvm + +To install rvm to `$HOME/.rvm` (as in a single-user setup), just execute the following: +``` +gpg --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB +curl -sSL https://get.rvm.io | bash -s -- --ignore-dotfiles +echo "source $HOME/.rvm/scripts/rvm" >> ~/.bash_profile +``` +Otherwise, read rvm's installation documentation: https://rvm.io/rvm/install + +## Install ruby and other dependencies ``` rvm install "$(cat .ruby-version)" gem install jekyll bundler bundle install ``` Then run the build locally: ``` bundle exec jekyll serve ``` # Providing Translations 1. Copy the file in `_posts/` that you wish to translate. 2. Set `lang` to the desired language code. 3. Verify that `multiLangId` is the same as the base filename **without** the language code. 4. Translate the file. # Troubleshooting ## Permission issues when executing 'arc land' If you are encountering various 'master not found on origin' or permission errors when attempting to land a diff for this website, then ensure your remotes are set to: ``` ssh://vcs@reviews.bitcoinabc.org:2221/source/bitcoin-abc-website.git ``` which can be verified via: ``` git remote -v ``` If you have a different remote connection for this website repo, update it: ``` git remote rm origin git remote add origin ssh://vcs@reviews.bitcoinabc.org:2221/source/bitcoin-abc-website.git ```