Fix readme
This commit is contained in:
@@ -15,7 +15,6 @@ Note that Windows' default conhost terminal emulator may have problem displaying
|
|||||||
```Shell
|
```Shell
|
||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
```
|
```
|
||||||
If you don't like to install packages to global/user scopes, you can also setup [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
|
|
||||||
|
|
||||||
1. Navigate to `conf/` directory and make a copy of each `.sample.json` files renaming each to remove `.sample` (ie, rename the copy to `sync_settings.json`).
|
1. Navigate to `conf/` directory and make a copy of each `.sample.json` files renaming each to remove `.sample` (ie, rename the copy to `sync_settings.json`).
|
||||||
Edit those files to populate the correct values.
|
Edit those files to populate the correct values.
|
||||||
@@ -24,7 +23,7 @@ Edit those files to populate the correct values.
|
|||||||
|
|
||||||
Run `main.py` in the terminal to start the application.
|
Run `main.py` in the terminal to start the application.
|
||||||
|
|
||||||
The program accept three optional positional parameters
|
The program accept two optional positional parameters
|
||||||
- Remote ItemID (such as `87654321012`). This can be found on the URL when browsing on box.com website. User's root directory is `0`. If not provided, will use jobs in `sync_settings.json`.
|
- Remote ItemID (such as `87654321012`). This can be found on the URL when browsing on box.com website. User's root directory is `0`. If not provided, will use jobs in `sync_settings.json`.
|
||||||
- Local directory that will represent the remote directory. Leave empty or use `.` for working directory (not tested).
|
- Local directory that will represent the remote directory. Leave empty or use `.` for working directory (not tested).
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user