Skip to content

Commit

Permalink
Revise documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hankcs committed Jun 30, 2021
1 parent 6d65332 commit 1d74fca
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
All resources HanLP use will be cached into a directory called `HANLP_HOME`.
It is an environment variable which you can customize to any path you like.
By default, `HANLP_HOME` resolves to `~/.hanlp` and `%appdata%\hanlp` on *nix and Windows respectively.
If you want to temporally redirect `HANLP_HOME` to a different location, say `/data/hanlp`, the following shell command can be very helpful.
If you want to redirect `HANLP_HOME` to a different location, say `/data/hanlp`, the following shell command can be very helpful.

```bash
export HANLP_HOME=/data/hanlp
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ project.
Get the source code of this project using git:

```bash
git clone https://github.com/hankcs/HanLP
git clone https://github.com/hankcs/HanLP --branch master
cd HanLP
pip install -e plugins/hanlp_trie
pip install -e plugins/hanlp_common
Expand All @@ -30,7 +30,7 @@ To work on this project, you need Python 3.6 or newer.
This project has a test suite to ensure certain important APIs work properly. The tests can be run using:

```console
$ python -m unittest discover ./tests
python -m unittest discover ./tests
```

:::{tip}
Expand Down
6 changes: 6 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ See [Golang instructions](https://hanlp.hankcs.com/docs/api/restful_golang.html)

The native package running locally can be installed via pip.

````{margin} **Install from Source**
```{note}
See [development guideline](https://hanlp.hankcs.com/docs/contributing.html#development).
```
````

```
pip install hanlp
```
Expand Down

0 comments on commit 1d74fca

Please sign in to comment.