aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPetr Šmerkl <46304018+SveterCZE@users.noreply.github.com>2021-10-17 09:54:56 +0200
committerGitHub <noreply@github.com>2021-10-17 09:54:56 +0200
commit2265d8ae5e055e2d79856408e9c92a19d75218a3 (patch)
treea670399d84313eaf20e1dd9d7d89dbcc5970ac5f
parent14a333de8dfad3399a93ad4cfd3cbce95df85dcb (diff)
downloadjustice-2265d8ae5e055e2d79856408e9c92a19d75218a3.tar.gz
Update README.md
formatting
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index 44e9a56..2c2619e 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,14 @@ My first larger project, an application using Pyhon, Flask and SQLite to downloa
<h1>Installation</h1>
Download a zip file containing the whole repository and store it into a folder on your PC. You should preferably use a virtual environment.
-See requirements.txt for required packages.
+See `requirements.txt` for required packages.
<h1>Running the application</h1>
-Firstly, you need to download the open data from the Ministry of Justice and build the database. Run "python justice_build.py", which will download all the source files, create an SQLite database and parse the downloaded data into the database. Note that after the downloaded data are uncompressed, they are around 13 GB and the database file has around 3.6 GB. It takes approximately 1 hour to download the data and build the database.
+Firstly, you need to download the open data from the Ministry of Justice and build the database.
-Once the database is built, run "python main.py" and open http://127.0.0.1:5000 You will be greeted with a search form that is described below.
+Run `python justice_build.py` which will download all the source files, create an SQLite database and parse the downloaded data into the database. Note that after the downloaded data are uncompressed, they are around 13 GB and the database file has around 3.6 GB. It takes approximately 1 hour to download the data and build the database.
+
+Once the database is built, run `python main.py` and open `http://127.0.0.1:5000` You will be greeted with a search form that is described below.
<h1>Features</h1>
<h2>Search by company properties</h2>