[release]

This commit is contained in:
junhuanchen
2022-07-06 11:24:18 +08:00
parent 617071829d
commit e75d983e11
2979 changed files with 179509 additions and 1570 deletions

66
README.md Normal file → Executable file
View File

@@ -1,48 +1,18 @@
Sipeed Wiki pages
===========
|[Read me online](https://wiki.sipeed.com/en/) | [在线阅读](https://wiki.sipeed.com/zh/) |
| ------------------------ | ----------- |
[![Build Status](https://travis-ci.org/sipeed/sipeed_wiki.svg?branch=master)](https://travis-ci.org/sipeed/sipeed_wiki)
-----------------------------------------------------------------------
## Build Doc
This documentation site is powered by GitBook. You can check out the online version here.
You need Node.js and npm to be able to build the site.
To install gitbook:
```
npm install gitbook-cli -g
```
Get Doc source code:
```
sudo apt install git
git clone https://github.com/sipeed/sipeed_wiki.git
```
Install gitbook plugins:
```
cd sipeed_wiki
gitbook install
```
Serve as a website:
```
chmod +x serve.sh
./serve.sh
```
Then visit http://localhost:4000
# Sipeed wiki source code
=====
Related site: [wiki.sipeed.com](https://wiki.sipeed.com)
If you want change document or add one, do the following choice.
## Fix error
If you find any error on wiki page, just fix it on github and **Commit changes**, thanks for correcting.
## Share article
We are glad that people share their article on our wiki page
Choose one language below to start to know how to share article.
[中文](./share_docs/zh/readme.md) [English](./share_docs/en/readme.md)