瀏覽代碼

Clarify README

dev
父節點
當前提交
42908c0eca
共有 1 個檔案被更改,包括 33 行新增26 行删除
  1. +33
    -26
      README.md

+ 33
- 26
README.md 查看文件

@@ -1,46 +1,53 @@
# Overview # Overview


We consider changing [Opensource Game Studio website](http://opengamestudio.org)'s This is an internal document describing how to update
engine from Wordpress to [Pelican](http://getpelican.com). This is Pelican [Opensource Game Studio website][opengamestudio]
evaluation. powered by [Pelican][pelican].


# Installation # Installation


You need a working Python's `pip`.

Install Pelican with the following command: Install Pelican with the following command:


`sudo apt install pelican` ```
sudo apt install pelican
```


# Preview # Preview


* Generate local copy with the following commands: To preview results locally:

`cd pelican`

`pelican -s pelicanconf.py`


* Serve the local copy with the following commands: * generate local copy with the following commands:
```
cd pelican
pelican -s pelicanconf.py
```
* serve the local copy with the following commands:
```
cd output
python -m SimpleHTTPServer
```


`cd output` The preview should now be available at [http://localhost:8000][preview].

`python -m SimpleHTTPServer`

The preview should now be available at
[http://localhost:8000](http://localhost:8000).


# Publishing # Publishing


* Generate public site with the following commands: To publish new content:

`cd pelican`


`pelican -s publishconf.py` * generate public site with the following commands:
```
cd pelican
pelican -s publishconf.py
```


* Upload it to GitHub with the following commands: * upload it to GitHub with the following command:
```
git push
```


`git push` The public site should now be available at
[Opensource Game Studio website][opengamestudio].


The publich site should now be available at [opengamestudio]: http://opengamestudio.org
[http://kaisd.github.io/ogs-site](http://kaisd.github.io/ogs-site). [pelican]: http://getpelican.com
[preview]: http://localhost:8000



Loading…
取消
儲存