This is an automated email from the ASF dual-hosted git repository.
rawkintrevo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/mahout.git
The following commit(s) were added to refs/heads/main by this push:
new 45d0d8827 Update README (#575)
45d0d8827 is described below
commit 45d0d882795eebd0c8f4e535cc3c715f054f3150
Author: Guan Ming(Wesley) Chiu <[email protected]>
AuthorDate: Mon Oct 6 03:52:34 2025 +0800
Update README (#575)
---
README.md | 2 +-
website/README.md | 57 ++++++++++++++++++++++++++++++----------------
website/_layouts/home.html | 2 +-
3 files changed, 40 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index b2de1388b..db1449a22 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ For additional information about Mahout, visit the [Mahout
Home Page](http://mah
# Qumat
-Qunat is a POC of a high level Python library for intefacing with multiple
quantum computing backends. It is designed to be easy to use and to abstract
the particularities of each backend, so that you may 'write once, run
anywhere.' Like the Java of quantum computing, but Java is the new COBOL so
we're trying to distance ourselves from that comparison :P
+Qumat is a POC of a high level Python library for intefacing with multiple
quantum computing backends. It is designed to be easy to use and to abstract
the particularities of each backend, so that you may 'write once, run
anywhere.' Like the Java of quantum computing, but Java is the new COBOL so
we're trying to distance ourselves from that comparison :P
Check out [basic gates](docs/basic_gates.md) for a quick introduction to the
basic gates. These are now supported across multiple quantum computing
frameworks, including Qiskit, Cirq, and Braket.
diff --git a/website/README.md b/website/README.md
index 9b07aba88..3f423b046 100644
--- a/website/README.md
+++ b/website/README.md
@@ -15,45 +15,64 @@
limitations under the License.
-->
- # The below are the steps to Setup the Apache Mahout Project Locally.
+# The below are the steps to Setup the Apache Mahout Project Locally
+
+## 0. Fork the repository
+
+Fork the repository to your own github account.
+
+## 1. Clone the repository
-# 1.Clone the repository
```bash
git clone https://github.com/username/mahout.git
cd mahout
```
+
Replace username with your github username.
+## 2. Install Jekyll Locally
+
+### Prerequisites
+
+- Ruby Version 2.7.0 or higher
+- RubyGems
+- GCC and Make
+
+### After installing the above pre-requisites, run the following in Terminal
-
- ## 2. Install Jekyll Locally
- ### A. Prerequisites
- - Ruby Version 2.7.0 or higher
- - RubyGems
- - GCC and Make
-## After installing the above pre-requisites, run the following in Terminal
```terminal
gem install jekyll bundler
```
-## Once the jekyll is installed, navigate to the website folder of the mahout
folder that is cloned in your system
-```
+## 3. Serve the website locally
+
+### Once the jekyll is installed, navigate to the website folder of the mahout
folder that is cloned in your system
+
+```bash
cd website
```
-## Run the following command while in website directory
-```
+
+### Run the following command while in website directory
+
+```bash
bundle exec jekyll serve
```
-### After running this, you would see the project locally setup at
http://localhost:4000/
-### Note: If you find any errors running the above command, make sure that
jekyll is upto date and ruby is installed on your system
+### After running this, you would see the project locally setup at
<http://localhost:4000/>
-## To install ruby in your system, run the following command in terminal
-```
+## 4. Trouble Shooting
+
+### Note: If you find any errors running the above command, make sure that
jekyll is upto date and ruby is installed on your system
+
+### To install ruby in your system, run the following command in terminal
+
+```bash
brew install ruby
```
- # How to post minutes on the home page
-1. Make a new GitHub Discussion like
https://github.com/apache/mahout/discussions/541
+
+### How to post minutes on the home page
+
+1. Make a new GitHub Discussion like
<https://github.com/apache/mahout/discussions/541>
2. Copy the latest Minutes in _posts to a new file, e.g., `cp
2025-05-16-Meeting-Minutes.md 2025-06-13-Meeting-Minutes.md`
3. Edit the new Minutes to reflect the new Discussion link (and update the
datestamp and attendees)
4. Add and commit, make a PR
diff --git a/website/_layouts/home.html b/website/_layouts/home.html
index 59373f96b..201189bea 100644
--- a/website/_layouts/home.html
+++ b/website/_layouts/home.html
@@ -16,7 +16,7 @@ layout: default
<div class="mahout-header-lower">
<div class="container position-relative mb-auto">
<h2 class="mb-4">For Creating Scalable Performant Machine Learning
Applications</h2>
- <a class="btn btn-lg btn-light btn-download mb-3"
href="https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=mahout/{{
site.mahout-version }}/mahout-qumat-{{ site.mahout-version }}.zip"><i
class="fa fa-download"></i> Download Mahout</a>
+ <a class="btn btn-lg btn-light btn-download mb-3"
href="https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=mahout/{{
site.mahout-version }}/mahout-qumat-{{ site.mahout-version }}.zip"><i
class="fa fa-download"></i> Download Mahout Qumat</a>
<div class="small text-white mx-auto">Currently v{{
site.mahout-version }}</div>
</div>
</div>
