You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tvm.apache.org by ar...@apache.org on 2021/11/19 19:40:11 UTC
[tvm-site] branch main updated: Update README with instructions on getting depdencies and serving (#31)
This is an automated email from the ASF dual-hosted git repository.
areusch pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tvm-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2e67c24 Update README with instructions on getting depdencies and serving (#31)
2e67c24 is described below
commit 2e67c242b45d10cb6dcd43f98317ce3089547d96
Author: driazati <94...@users.noreply.github.com>
AuthorDate: Fri Nov 19 11:40:07 2021 -0800
Update README with instructions on getting depdencies and serving (#31)
This are the commands I had to run to get the docs building on an Ubuntu machine
Co-authored-by: driazati <dr...@users.noreply.github.com>
---
.gitignore | 3 +++
README.md | 31 +++++++++++++++++++++++++++++--
serve_local.sh | 2 +-
3 files changed, 33 insertions(+), 3 deletions(-)
diff --git a/.gitignore b/.gitignore
index cf6401d..72a3cf5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,6 @@ website.tgz
.jekyll-cache
docs.tgz
Gemfile.lock
+.bundle/
+vendor/
+
diff --git a/README.md b/README.md
index f8fb49a..280a78b 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,43 @@
# TVM Project Homepage
-## Prereq
+## Dependencies
-- Install the jekyll and bundler gems `gem install bundler jekyll`
+1. Install Ruby
+ ```bash
+ # for Ubuntu 18.04+
+ sudo apt install -y ruby-full build-essential
+ ```
+
+2. Install Jekyll and Bundler gems
+
+ ```bash
+ gem install bundler jekyll
+ ```
+
+3. Install project dependencies
+
+ ```bash
+ git clone https://github.com/apache/tvm-site.git
+ cd tvm-site
+
+ # If this runs into resolution errors, you may need to run:
+ # bundle config set --local path 'vendor/cache'
+ bundle install
+ ```
## Serve Locally
```bash
./serve_local.sh
+
+# If you are developing on a remote machine, you can set up an SSH tunnel to view
+# the site locally:
+ssh -L 4000:localhost:4000 <the remote>
```
+Then visit [http://localhost:4000](http://localhost:4000) in your browser.
+
## Deployment
We use the script [scripts/task_deploy_asf_site.sh](scripts/task_deploy_asf_site.sh)
diff --git a/serve_local.sh b/serve_local.sh
index d4a58f9..dbae332 100755
--- a/serve_local.sh
+++ b/serve_local.sh
@@ -1,3 +1,3 @@
#!/bin/bash
rm -rf _site
-jekyll serve --watch
+bundle exec jekyll serve --watch