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:
parent
95fb90b79c
commit
601d773ebb
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
@ -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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue