1
0
Fork 0
mirror of https://github.com/overleaf/toolkit.git synced 2025-04-19 15:28:06 +02:00

Add some basic docs to README file

This commit is contained in:
Shane Kilkelly 2020-06-05 11:00:42 +01:00
parent 95fb90b79c
commit 601d773ebb

View file

@ -1 +1,21 @@
# Overleaf Toolkit
## Getting Started
- Run `bin/init`
- this will populate config files in `config/`
- Run `bin/up`
- this will start the service with docker-compose
## Doctor
Run `bin/doctor` for debug output
## Config files
- `config/docker-compose.yml`
- base config file for docker-compose, not meant to be edited
- `config/local.yml`
- local overrides, and environment configuration, editable