forked from mrlan/EnglishPal
README.md: correct section levels.
Lan Hui
parent
4c9b471317
commit
9ffc124ac3
82
README.md
82
README.md
|
|
@ -1,5 +1,5 @@
|
|||
EnglishPal - Learn English Words Smartly
|
||||
==========================================
|
||||
# EnglishPal - Learn English Words Smartly
|
||||
|
||||
|
||||
|
||||
Hui Lan <hui.lan@cantab.net>
|
||||
|
|
@ -7,23 +7,23 @@ Hui Lan <hui.lan@cantab.net>
|
|||
1 November 2019
|
||||
|
||||
|
||||
What is it?
|
||||
-----------------
|
||||
## What is it?
|
||||
|
||||
|
||||
EnglishPal allows the user to build his list of new English words
|
||||
picked from articles selected for him according his vocabulary level.
|
||||
|
||||
|
||||
Run it on a local machine
|
||||
-------------------------
|
||||
## Run it on a local machine
|
||||
|
||||
|
||||
`python3 main.py`
|
||||
|
||||
Make sure you have the SQLite database file in `app/static` (see below).
|
||||
|
||||
|
||||
Run it as a Docker container
|
||||
----------------------------
|
||||
## Run it as a Docker container
|
||||
|
||||
|
||||
Assuming that docker has been installed and that you are a sudo user (i.e., sudoer), start the program by typing the following command in directory `EnglishPal`:
|
||||
|
||||
|
|
@ -31,8 +31,7 @@ Assuming that docker has been installed and that you are a sudo user (i.e., sudo
|
|||
|
||||
Open your favourite Internet browser and enter this URL address: `http://ip-address:90`.
|
||||
|
||||
Explanation on the commands in build.sh
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
### Explanation on the commands in build.sh
|
||||
|
||||
My steps for deploying English on the server.
|
||||
|
||||
|
|
@ -49,8 +48,7 @@ My steps for deploying English on the server.
|
|||
- Save space: `sudo docker system prune -a -f`
|
||||
|
||||
|
||||
Other useful docker commands
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
### Other useful docker commands
|
||||
|
||||
- `sudo docker ps -a`
|
||||
|
||||
|
|
@ -60,20 +58,17 @@ Other useful docker commands
|
|||
|
||||
|
||||
|
||||
Update articles
|
||||
---------------
|
||||
## Importing articles
|
||||
|
||||
|
||||
All articles are stored in the `article` table in a SQLite file called
|
||||
`app/static/wordfreqapp.db`.
|
||||
|
||||
Adding new articles
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
### Adding new articles
|
||||
|
||||
To add articles, open and edit `app/static/wordfreqapp.db` using DB Browser for SQLite (https://sqlitebrowser.org).
|
||||
|
||||
Exporting the database
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
### Exporting the database
|
||||
|
||||
Export wordfreqapp.db to wordfreqapp.sql using the following commands:
|
||||
|
||||
|
|
@ -87,32 +82,33 @@ Export wordfreqapp.db to wordfreqapp.sql using the following commands:
|
|||
|
||||
Put wordfreqapp.sql (not wordfreqapp.db) under version control.
|
||||
|
||||
Creating SQLite file from wordfreqapp.sql
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
### Creating SQLite file from wordfreqapp.sql
|
||||
|
||||
|
||||
Create wordfreqapp.db using this command: `cat wordfreqapp.sql |
|
||||
sqlite3 wordfreqapp.db`. Delete wordfreqapp.db first if it exists.
|
||||
|
||||
Uploading wordfreqapp.db
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
### Uploading wordfreqapp.db to the server
|
||||
|
||||
|
||||
`pscp wordfreqapp.db lanhui@118.*.*.118:/home/lanhui/englishpal/app/static`
|
||||
|
||||
|
||||
|
||||
Feedback
|
||||
---------------------
|
||||
## Feedback
|
||||
|
||||
We welcome feedback on EnglishPal.
|
||||
|
||||
### Respondent 1
|
||||
|
||||
Respondent 1
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
"Need a phone app. I use phone a lot. You cannot ask students to use computers."
|
||||
|
||||
Can take a picture for text. Automatic translation.
|
||||
|
||||
Respondent 2
|
||||
~~~~~~~~~~~~
|
||||
### Respondent 2
|
||||
|
||||
|
||||
“成为会员”改成“注册”
|
||||
|
||||
|
|
@ -126,26 +122,26 @@ Respondent 2
|
|||
|
||||
|
||||
|
||||
Bug tracking
|
||||
-------------------
|
||||
## Bug tracking
|
||||
|
||||
|
||||
EnglishPal's bugs and improvement suggestions are recorded in [Bugzilla](http://118.25.96.118/bugzilla/buglist.cgi?bug_status=__all__&list_id=1302&order=Importance&product=EnglishPal&query_format=specific). Send (lanhui at zjnu.edu.cn) an email message for opening a Bugzilla account or reporting a bug.
|
||||
|
||||
|
||||
|
||||
TODO
|
||||
----------
|
||||
## TODO
|
||||
|
||||
|
||||
- Fix Bug: Internal server error when register using an email address.
|
||||
|
||||
- Usability testing
|
||||
|
||||
|
||||
Improvements made by contributors
|
||||
-----------------------------------
|
||||
## Improvements made by contributors
|
||||
|
||||
|
||||
### 朱文绮
|
||||
|
||||
朱文绮
|
||||
~~~~~~~~~
|
||||
|
||||
在生词簿每个单词后面，加上两个按钮，熟悉与不熟悉:
|
||||
|
||||
|
|
@ -153,8 +149,8 @@ Improvements made by contributors
|
|||
|
||||
- 如果点不熟悉，就将生词簿中该单词后面记录的添加次数加一。
|
||||
|
||||
李康恬
|
||||
~~~~~~~~~~~
|
||||
### 李康恬
|
||||
|
||||
|
||||
Add the function of "Delete already known and well-known words from
|
||||
the words' library", on the one hand, it can conform to the usage
|
||||
|
|
@ -166,8 +162,8 @@ can also improve the simplicity of the page.
|
|||
More information at: http://118.25.96.118/kanboard/?controller=TaskViewController&action=readonly&task_id=736&token=81a561da57ff7a172da17a480f0d421ff3bc69efbd29437daef90b1b8959
|
||||
|
||||
|
||||
占健豪
|
||||
~~~~~~~~
|
||||
### 占健豪
|
||||
|
||||
|
||||
Click the Familiar or Unfamiliar button (current word frequency>1), the current word position is displayed at the top of the page;
|
||||
|
||||
|
|
@ -175,8 +171,8 @@ Click the Familiar or Unfamiliar button (current word frequency is 1), and the p
|
|||
|
||||
Demo video link: https://b23.tv/QuB77m
|
||||
|
||||
张小飞
|
||||
~~~~~~~~~~~~
|
||||
### 张小飞
|
||||
|
||||
|
||||
修复了以下漏洞。
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue