Add Installation section to README.md
- Added Installation section to README.md - Removed old Usage section
This commit is contained in:
parent
065296f84a
commit
4309225185
22
README.md
22
README.md
@ -4,6 +4,22 @@
|
|||||||
### What is imgupload?
|
### What is imgupload?
|
||||||
imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.
|
imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.
|
||||||
|
|
||||||
### Usage
|
### Installation
|
||||||
Make sure you install the dependencies first. To do this, run `sudo python3 -m pip install -r requirements.txt`.
|
1. Clone the repository: `git clone https://github.com/BBaoVanC/imgupload.git`
|
||||||
To deploy imgupload, run `flask run`.
|
2. Enter the imgupload directory: `cd imgupload`
|
||||||
|
3. Create a virtualenv: `python3 -m venv env`
|
||||||
|
4. Enter the virtualenv: `source env/bin/activate`
|
||||||
|
5. Install dependencies: `python3 -m pip install -r requirements.txt`
|
||||||
|
6. Run the Flask app
|
||||||
|
|
||||||
|
### Running the Flask app
|
||||||
|
## Using uWSGI
|
||||||
|
[https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html](https://uwsgi-docs.readthedocs.io/en/latest/Configuration.html)
|
||||||
|
Instructions specific to imgupload are coming soon
|
||||||
|
|
||||||
|
## Using Flask development server
|
||||||
|
```shell
|
||||||
|
$ source env/bin/activate # if you haven't already entered the virtualenv
|
||||||
|
$ export FLASK_APP=imgupload.py
|
||||||
|
$ flask run
|
||||||
|
```
|
||||||
|
Reference in New Issue
Block a user