update readme.md
This commit is contained in:
30
README.md
30
README.md
@ -1,4 +1,4 @@
|
||||
## Introduction
|
||||
## 1. Introduction
|
||||
|
||||
Leanote, a cloud note. You can create your own cloud note by leanote.
|
||||
|
||||
@ -8,23 +8,23 @@ Leanote, a cloud note. You can create your own cloud note by leanote.
|
||||
* Cooperation: collaborate with friends to improve your knowledge.
|
||||
* Blog: public your knowledge and leanote be your blog.
|
||||
|
||||
## Why we create leanote
|
||||
## 2. Why we create leanote
|
||||
To be honest, our inspiration comes from evernote, and we use evenote to manage our knowledge everyday. But we find that:
|
||||
* Evernote's editor can't meet our needs, it hasn't document navigation, can't put our codes(as a programmer, put codes is the basic needs), can't resize images...)
|
||||
* We like markdown, but evernote don't support it.
|
||||
* We want to public our knowledge, so we have our blog(such as wordpress) and evernote, but why can't be the one!
|
||||
* ......
|
||||
|
||||
## How to use it
|
||||
## 3. How to install leanote
|
||||
|
||||
## Download leanote
|
||||
### 3.1. Download leanote
|
||||
|
||||
Leanote v0.1 has released.
|
||||
|
||||
* linux: https://github.com/leanote/leanote/releases/download/0.1/leanote-linux-v0.1.bin.tar.gz
|
||||
* mac ox: https://github.com/leanote/leanote/releases/download/0.1/leanote-mac-v0.1.tar.gz
|
||||
|
||||
### Install mongodb
|
||||
### 3.2. Install mongodb
|
||||
|
||||
Leanote build with golang(revel) and mongodb. so you must install mongodb at first.
|
||||
|
||||
@ -32,7 +32,7 @@ For more tips please go https://github.com/leanote/leanote/wiki/mongodb-in-leano
|
||||
|
||||
Go http://www.mongodb.org to download and install it.
|
||||
|
||||
### Export initial mongodb data
|
||||
### 3.3. Export initial mongodb data
|
||||
|
||||
The mongodb data is in path_to_leante/mongodb_backup/leanote_install_data
|
||||
|
||||
@ -47,7 +47,7 @@ user1 username: leanote, password: abc123
|
||||
user2 username: admin, password: abc123
|
||||
```
|
||||
|
||||
### Configuration
|
||||
### 3.4. Configuration
|
||||
|
||||
Modify path_to_leanote/conf/app.conf, the configuration options contains:
|
||||
|
||||
@ -79,40 +79,40 @@ Default is admin. The index site is the adminUsername's blog
|
||||
|
||||
For more infomation please see app/app.conf and revel manuals http://revel.github.io
|
||||
|
||||
### Run leanote
|
||||
### 3.5. Run leanote
|
||||
|
||||
```
|
||||
$> cd path_to_leanote/bin
|
||||
$> sudo sh run.sh
|
||||
```
|
||||
|
||||
## How to develop leanote
|
||||
## 4. How to develop leanote
|
||||
|
||||
For more tips please go https://github.com/leanote/leanote/wiki/How-to-develop-leanote
|
||||
|
||||
Leanote is a app based on revel(http://revel.github.io), so if you want to develop leanote as you want, you must be familar with revel.
|
||||
|
||||
### Install golang
|
||||
### 4.1 Install golang
|
||||
|
||||
Install golang and set GOPATH
|
||||
|
||||
### Install revel
|
||||
### 4.2 Install revel
|
||||
```
|
||||
$> go get github.com/revel/revel
|
||||
$> go get github.com/revel/cmd/revel
|
||||
```
|
||||
|
||||
### Get leanote
|
||||
### 4.3 Get leanote
|
||||
|
||||
```
|
||||
$> go get github.com/leanote/leanote/app
|
||||
```
|
||||
|
||||
### Build/Run leanote via revel
|
||||
### 4.4 Build/Run leanote via revel
|
||||
|
||||
```
|
||||
$> cp conf/app.conf-default to conf/app.conf
|
||||
$> cp conf/routes-default to conf/routes
|
||||
$> cp conf/app.conf-default conf/app.conf
|
||||
$> cp conf/routes-default conf/routes
|
||||
```
|
||||
|
||||
Now you can modify leanote source and build/run with revel
|
||||
|
Reference in New Issue
Block a user