From 8348599e6a282ac82c55e025f457a92030c2be35 Mon Sep 17 00:00:00 2001 From: Bryan Newbold Date: Tue, 9 Mar 2021 23:33:40 -0800 Subject: revert some README markdown syntax changes, for readability --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7fad947..28d9a25 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ +
-# `fatcat-scholar` / Internet Archive Scholar +`fatcat-scholar` / Internet Archive Scholar +=========================================== This is source code for [scholar.archive.org](https://scholar.archive.org), a full-text web search interface over the 25+ million open research papers in the @@ -13,15 +15,16 @@ handled by the [fatcat](https://fatcat.wiki) service; this service is just a ba search interface. Unlike the basic fatcat.wiki search, this index allows querying the full content of papers when available. + ## Overview This repository is fairly small and contains: -- `fatcat_scholar/`: Python code for web service and indexing pipeline -- `fatcat_scholar/templates/`: HTML template for web interface -- `tests/`: Python test files -- `proposals/`: design documentation and change proposals -- `data/`: empty directory for indexing pipeline +- `fatcat_scholar/`: Python code for web service and indexing pipeline +- `fatcat_scholar/templates/`: HTML template for web interface +- `tests/`: Python test files +- `proposals/`: design documentation and change proposals +- `data/`: empty directory for indexing pipeline A data pipeline converts groups of one or more fatcat "release" entities (grouped under a single "work" entity) into a single search index document. @@ -33,6 +36,7 @@ The current Python web framework is FastAPI, though the number of routes is very small and it would be easy to switch to a more conventional framework like Flask. + ## Getting Started for Developers You need `pipenv` and Python 3.8 installed. Most tasks are run using a @@ -69,6 +73,7 @@ automatically. This repository uses `black` for code formatting; please run `make fmt` and `make lint` for submitting a pull request. + ## Contributing Software, copy-editing, translation, and other contributions to this repository -- cgit v1.2.3