aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-02-04 18:05:40 -0800
committerBryan Newbold <bnewbold@archive.org>2021-02-04 18:05:40 -0800
commitdbff9cb6342261bc12ccd831d5bf06b485e5a794 (patch)
tree36215ec60a171b9c41afa51d6425a77b9f87ff69 /README.md
parent7cb5182bdcfad58069c5e0341b6ce19b8301b09c (diff)
downloadfatcat-scholar-dbff9cb6342261bc12ccd831d5bf06b485e5a794.tar.gz
fatcat-scholar-dbff9cb6342261bc12ccd831d5bf06b485e5a794.zip
minor tweaks to README syntax
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 4e6a5d5..c9c42ba 100644
--- a/README.md
+++ b/README.md
@@ -49,12 +49,11 @@ are probably possible without staff access.
To install dependencies for the first time run:
- `make dep`
+ make dep
then run the tests (to ensure everything is working):
- `make test`
-
+ make test
While developing the web interface, you will almost certainly need an example
database running locally. A docker-compose file in `extra/docker/` can be used
@@ -63,7 +62,10 @@ local index with the correct schema mapping, and index any intermediate files
in the `./data/` directory. We don't have an out-of-the-box solution for non-IA
staff at this step (yet).
-After making changes to any user interface strings, the interface translation file (".pot") needs to be updated with `make extract-i18n`. When these changes are merged to master, the Weblate translation system will be updated automatically.
+After making changes to any user interface strings, the interface translation
+file (".pot") needs to be updated with `make extract-i18n`. When these changes
+are merged to master, the Weblate translation system will be updated
+automatically.
This repository uses `black` for code formatting; please run `make fmt` and
`make lint` for submitting a pull request.