mirror of
https://github.com/overleaf/toolkit.git
synced 2025-04-19 23:38:06 +02:00
Update readme, ad a todo list
This commit is contained in:
parent
8eac3140db
commit
6b70d10420
1 changed files with 22 additions and 0 deletions
22
README.md
22
README.md
|
@ -19,3 +19,25 @@ Run `bin/doctor` for debug output
|
|||
- base config file for docker-compose, not meant to be edited
|
||||
- `config/local.yml`
|
||||
- local overrides, and environment configuration, editable
|
||||
|
||||
|
||||
## Data directories
|
||||
|
||||
- `data/mongo`
|
||||
- `data/redis`
|
||||
- `data/sharelatex`
|
||||
|
||||
All are persisted outside of the containers.
|
||||
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Improve the init script
|
||||
- [ ] Figure out if we can have a separate `image.txt` file
|
||||
- [ ] Cleaner config, especially in `local.yml`
|
||||
- [ ] Re-assess naming of config files
|
||||
- [ ] Consistent `--help` output from each tool
|
||||
- [ ] Full documentation
|
||||
- [ ] New user walkthrough
|
||||
- [ ] Documentation for each file
|
||||
- [ ] Documentation for each tool in the bin folder
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue