Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ogawa committed Jul 7, 2019
1 parent 7c55c2e commit a599d62
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# README

The primary goal of this project is to organize a concerted community effort to improve the ABCI Users Guide that explains how to utilize [AI Bridging Cloud Infrastructure (ABCI)](https://abci.ai/). ABCI is the world's first large-scale Open AI Computing Infrastructure, constructed and operated by [National Institute of Advanced Industrial Science and Technology (AIST)](https://www.aist.go.jp/). We would welcome your feedbacks including pull requests.
The primary goal of this project is to organize a concerted community effort to improve the ABCI Users Guide and Portal Guide that explain how to utilize [AI Bridging Cloud Infrastructure (ABCI)](https://abci.ai/).
ABCI is the world's first large-scale Open AI Computing Infrastructure, constructed and operated by [National Institute of Advanced Industrial Science and Technology (AIST)](https://www.aist.go.jp/).
We would welcome your feedbacks including pull requests.

On every *release* we will deploy it as the current *official* version of the ABCI User Guide, which is located at [https://docs.abci.ai/](https://docs.abci.ai/).
On every *release* we will deploy it as the current *official* versions of the ABCI Users Guide and Portal Guide, which are located at [https://docs.abci.ai/](https://docs.abci.ai/).

## Structure of the repository

Expand All @@ -23,8 +25,7 @@ You can clone the repository to your local environment and run the builtin devel

```
$ pip install mkdocs
$ pip install mkdocs-material
$ pip install ghp-import
$ pip install mkdocs-material==4.3.1
$ git clone https://github.com/aistairc/abci-docs.git
$ cd abci-docs
$ cd root/ or ja/ or en/
Expand All @@ -45,5 +46,6 @@ $ make -f site.mk
And, to deploy and publish generated documents to `gh-pages` branch:

```
$ pip install ghp-import
$ ghp-import -c docs.abci.ai -r origin -b gh-pages -p site
```

0 comments on commit a599d62

Please sign in to comment.