Mirror/MarginaliaSearch
1
0
Fork 0
mirror of https://github.com/MarginaliaSearch/MarginaliaSearch.git synced 2025-02-23 13:09:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

More documentation...

Browse Source
This commit is contained in:
Viktor Lofgren 2023-03-06 18:45:01 +01:00
parent b945fd7f39
commit 2d066af5b9
2 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -11,10 +11,6 @@ requiring datacenters and expensive enterprise hardware, to run this operation o
Follow instructions in [run](run/).
## Documentation
Documentation is a work in progress.
## Contributing
[CONTRIBUTING.md](CONTRIBUTING.md)

8
run/readme.md
View File

@ -4,12 +4,14 @@ When developing locally, this directory will contain run-time data required for
the search engine. In a clean check-out, it only contains the tools required to
bootstrap this directory structure.
## Set up
## Requirements
While the system is designed to run bare metal in production,
for local development, you're strongly encouraged to use docker
or podman.
or podman. These are a bit of a pain to install, but if you follow
[this guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
you're on the right track.
## Set up
To go from a clean check out of the git repo to a running search engine,
follow these steps. You're assumed to sit in the project root the whole time.