mirrors/copyparty
1
0
Fork 0
mirror of https://github.com/9001/copyparty.git synced 2025-08-17 09:02:15 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

add summaries to readme toc

Browse source
This commit is contained in:
ed 2021-08-22 17:23:42 +02:00
parent 2b6b174517
commit cc05e67d8f
2 changed files with 96 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

146
README.md
View file

@ -19,52 +19,53 @@ turn your phone or raspi into a portable file server with resumable uploads/down
## readme toc ## readme toc
* top * top
* [quickstart](#quickstart) * [quickstart](#quickstart) - download [copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py) and you're all set!
* [on debian](#on-debian) * [on debian](#on-debian) - recommended additional steps on debian
* [notes](#notes) * [notes](#notes) - general notes
* [status](#status) * [status](#status) - summary: all planned features work! now please enjoy the bloatening
* [testimonials](#testimonials) * [testimonials](#testimonials) - small collection of user feedback
* [bugs](#bugs) * [bugs](#bugs)
* [general bugs](#general-bugs) * [general bugs](#general-bugs)
* [not my bugs](#not-my-bugs) * [not my bugs](#not-my-bugs)
* [accounts and volumes](#accounts-and-volumes) * [accounts and volumes](#accounts-and-volumes) - per-folder permissions for specific users
* [the browser](#the-browser) * [the browser](#the-browser) - accessing a copyparty server using a web-browser
* [tabs](#tabs) * [tabs](#tabs) - the main tabs in the ui
* [hotkeys](#hotkeys) * [hotkeys](#hotkeys) - the browser has the following hotkeys (always qwerty)
* [navpane](#navpane) * [navpane](#navpane) - switching between breadcrumbs or navpane
* [thumbnails](#thumbnails) * [thumbnails](#thumbnails) - press `g` to toggle image/video thumbnails instead of the file listing
* [zip downloads](#zip-downloads) * [zip downloads](#zip-downloads) - download folders (or file selections) as `zip` or `tar` files
* [uploading](#uploading) * [uploading](#uploading) - web-browsers can upload using `bup` and `up2k`
* [file-search](#file-search) * [file-search](#file-search) - drop files/folders into up2k to see if they exist on the server
* [unpost](#unpost) * [unpost](#unpost) - undo/delete accidental uploads
* [file manager](#file-manager) * [file manager](#file-manager) - cut/paste, rename, and delete files/folders (if you have permission)
* [batch rename](#batch-rename) * [batch rename](#batch-rename) - select some files and press F2 to bring up the rename UI
* [markdown viewer](#markdown-viewer) * [markdown viewer](#markdown-viewer) - and there are *two* editors
* [other tricks](#other-tricks) * [other tricks](#other-tricks)
* [searching](#searching) * [searching](#searching) - search by size, date, path/name, mp3-tags, ...
* [server config](#server-config) * [server config](#server-config)
* [upload rules](#upload-rules) * [file indexing](#file-indexing)
* [compress uploads](#compress-uploads) * [upload rules](#upload-rules) - set upload rules using volume flags, some examples
* [database location](#database-location) * [compress uploads](#compress-uploads) - files can be autocompressed on upload
* [metadata from audio files](#metadata-from-audio-files) * [database location](#database-location) - can be stored in-volume (default) or elsewhere
* [file parser plugins](#file-parser-plugins) * [metadata from audio files](#metadata-from-audio-files) - set `-e2t` to index tags on upload
* [file parser plugins](#file-parser-plugins) - provide custom parsers to index additional tags
* [complete examples](#complete-examples) * [complete examples](#complete-examples)
* [browser support](#browser-support) * [browser support](#browser-support) - TLDR: yes
* [client examples](#client-examples) * [client examples](#client-examples) - interact with copyparty using non-browser clients
* [up2k](#up2k) * [up2k](#up2k) - quick outline of the up2k protocol, see [uploading](#uploading) for the web-client
* [performance](#performance) * [performance](#performance) - defaults are good for most cases
* [dependencies](#dependencies) * [dependencies](#dependencies) - mandatory deps
* [optional dependencies](#optional-dependencies) * [optional dependencies](#optional-dependencies) - install these to enable bonus features
* [install recommended deps](#install-recommended-deps) * [install recommended deps](#install-recommended-deps)
* [optional gpl stuff](#optional-gpl-stuff) * [optional gpl stuff](#optional-gpl-stuff)
* [sfx](#sfx) * [sfx](#sfx) - there are two self-contained "binaries"
* [sfx repack](#sfx-repack) * [sfx repack](#sfx-repack) - reduce the size of an sfx by disabling features
* [install on android](#install-on-android) * [install on android](#install-on-android)
* [building](#building) * [building](#building)
* [dev env setup](#dev-env-setup) * [dev env setup](#dev-env-setup)
* [just the sfx](#just-the-sfx) * [just the sfx](#just-the-sfx)
* [complete release](#complete-release) * [complete release](#complete-release)
* [todo](#todo) * [todo](#todo) - roughly sorted by priority
* [discarded ideas](#discarded-ideas) * [discarded ideas](#discarded-ideas)
@ -89,7 +90,9 @@ you may also want these, especially on servers:
### on debian ### on debian
recommended steps to enable audio metadata and thumbnails (from images and videos): recommended additional steps on debian
enable audio metadata and thumbnails (from images and videos):
* as root, run the following: * as root, run the following:
`apt install python3 python3-pip python3-dev ffmpeg` `apt install python3 python3-pip python3-dev ffmpeg`
@ -102,7 +105,7 @@ recommended steps to enable audio metadata and thumbnails (from images and video
## notes ## notes
general: general notes:
* paper-printing is affected by dark/light-mode! use lightmode for color, darkmode for grayscale * paper-printing is affected by dark/light-mode! use lightmode for color, darkmode for grayscale
* because no browsers currently implement the media-query to do this properly orz * because no browsers currently implement the media-query to do this properly orz
@ -187,6 +190,7 @@ small collection of user feedback
# accounts and volumes # accounts and volumes
per-folder permissions for specific users
* `-a usr:pwd` adds account `usr` with password `pwd` * `-a usr:pwd` adds account `usr` with password `pwd`
* `-v .::r` adds current-folder `.` as the webroot, `r`eadable by anyone * `-v .::r` adds current-folder `.` as the webroot, `r`eadable by anyone
* the syntax is `-v src:dst:perm:perm:...` so local-path, url-path, and one or more permissions to set * the syntax is `-v src:dst:perm:perm:...` so local-path, url-path, and one or more permissions to set
@ -211,11 +215,14 @@ example:
# the browser # the browser
accessing a copyparty server using a web-browser
![copyparty-browser-fs8](https://user-images.githubusercontent.com/241032/129635359-d6dd9b07-8079-4020-ad77-2bfdb9ebd8d5.png) ![copyparty-browser-fs8](https://user-images.githubusercontent.com/241032/129635359-d6dd9b07-8079-4020-ad77-2bfdb9ebd8d5.png)
## tabs ## tabs
the main tabs in the ui
* `[🔎]` [search](#searching) by size, date, path/name, mp3-tags ... * `[🔎]` [search](#searching) by size, date, path/name, mp3-tags ...
* `[🧯]` [unpost](#unpost): undo/delete accidental uploads * `[🧯]` [unpost](#unpost): undo/delete accidental uploads
* `[🚀]` and `[🎈]` are the [uploaders](#uploading) * `[🚀]` and `[🎈]` are the [uploaders](#uploading)
@ -228,7 +235,7 @@ example:
## hotkeys ## hotkeys
the browser has the following hotkeys (assumes qwerty, ignores actual layout) the browser has the following hotkeys (always qwerty)
* `B` toggle breadcrumbs / navpane * `B` toggle breadcrumbs / navpane
* `I/K` prev/next folder * `I/K` prev/next folder
* `M` parent folder (or unexpand current) * `M` parent folder (or unexpand current)
@ -277,13 +284,17 @@ the browser has the following hotkeys (assumes qwerty, ignores actual layout)
## navpane ## navpane
by default there's a breadcrumbs path; you can replace this with a navpane (tree-browser sidebar thing) by clicking the `🌲` or pressing the `B` hotkey switching between breadcrumbs or navpane
click the `🌲` or pressing the `B` hotkey to toggle between breadcrumbs path (default), or a navpane (tree-browser sidebar thing)
click `[-]` and `[+]` (or hotkeys `A`/`D`) to adjust the size, and the `[a]` toggles if the tree should widen dynamically as you go deeper or stay fixed-size click `[-]` and `[+]` (or hotkeys `A`/`D`) to adjust the size, and the `[a]` toggles if the tree should widen dynamically as you go deeper or stay fixed-size
## thumbnails ## thumbnails
press `g` to toggle image/video thumbnails instead of the file listing
![copyparty-thumbs-fs8](https://user-images.githubusercontent.com/241032/129636211-abd20fa2-a953-4366-9423-1c88ebb96ba9.png) ![copyparty-thumbs-fs8](https://user-images.githubusercontent.com/241032/129636211-abd20fa2-a953-4366-9423-1c88ebb96ba9.png)
it does static images with Pillow and uses FFmpeg for video files, so you may want to `--no-thumb` or maybe just `--no-vthumb` depending on how dangerous your users are it does static images with Pillow and uses FFmpeg for video files, so you may want to `--no-thumb` or maybe just `--no-vthumb` depending on how dangerous your users are
@ -295,7 +306,9 @@ in the grid/thumbnail view, if the audio player panel is open, songs will start
## zip downloads ## zip downloads
the `zip` link next to folders can produce various types of zip/tar files using these alternatives in the browser settings tab: download folders (or file selections) as `zip` or `tar` files
select which type of archive you want in the browser settings tab:
| name | url-suffix | description | | name | url-suffix | description |
|--|--|--| |--|--|--|
@ -314,9 +327,10 @@ you can also zip a selection of files or folders by clicking them in the browser
![copyparty-zipsel-fs8](https://user-images.githubusercontent.com/241032/129635374-e5136e01-470a-49b1-a762-848e8a4c9cdc.png) ![copyparty-zipsel-fs8](https://user-images.githubusercontent.com/241032/129635374-e5136e01-470a-49b1-a762-848e8a4c9cdc.png)
## uploading ## uploading
two upload methods are available in the html client: web-browsers can upload using `bup` and `up2k`:
* `[🎈] bup`, the basic uploader, supports almost every browser since netscape 4.0 * `[🎈] bup`, the basic uploader, supports almost every browser since netscape 4.0
* `[🚀] up2k`, the fancy one * `[🚀] up2k`, the fancy one
@ -342,7 +356,7 @@ the up2k UI is the epitome of polished inutitive experiences:
* "parallel uploads" specifies how many chunks to upload at the same time * "parallel uploads" specifies how many chunks to upload at the same time
* `[🏃]` analysis of other files should continue while one is uploading * `[🏃]` analysis of other files should continue while one is uploading
* `[💭]` ask for confirmation before files are added to the list * `[💭]` ask for confirmation before files are added to the list
* `[💤]` sync uploading between other copyparty tabs so only one is active * `[💤]` sync uploading between other copyparty browser-tabs so only one is active
* `[🔎]` switch between upload and file-search mode * `[🔎]` switch between upload and file-search mode
and then theres the tabs below it, and then theres the tabs below it,
@ -353,11 +367,14 @@ and then theres the tabs below it,
* plus up to 3 entries each from `[done]` and `[que]` for context * plus up to 3 entries each from `[done]` and `[que]` for context
* `[que]` is all the files that are still queued * `[que]` is all the files that are still queued
### file-search ### file-search
drop files/folders into up2k to see if they exist on the server
![copyparty-fsearch-fs8](https://user-images.githubusercontent.com/241032/129635361-c79286f0-b8f1-440e-aaf4-6e929428fac9.png) ![copyparty-fsearch-fs8](https://user-images.githubusercontent.com/241032/129635361-c79286f0-b8f1-440e-aaf4-6e929428fac9.png)
in the `[🚀 up2k]` tab, after toggling the `[🔎]` switch green, any files/folders you drop onto the dropzone will be hashed on the client-side. Each hash is sent to the server which checks if that file exists somewhere already in the `[🚀 up2k]` tab, after toggling the `[🔎]` switch green, any files/folders you drop onto the dropzone will be hashed on the client-side. Each hash is sent to the server which checks if that file exists somewhere
files go into `[ok]` if they exist (and you get a link to where it is), otherwise they land in `[ng]` files go into `[ok]` if they exist (and you get a link to where it is), otherwise they land in `[ng]`
* the main reason filesearch is combined with the uploader is cause the code was too spaghetti to separate it out somewhere else, this is no longer the case but now i've warmed up to the idea too much * the main reason filesearch is combined with the uploader is cause the code was too spaghetti to separate it out somewhere else, this is no longer the case but now i've warmed up to the idea too much
@ -371,24 +388,26 @@ up2k has saved a few uploads from becoming corrupted in-transfer already; caught
### unpost ### unpost
undo/delete accidental uploads
![copyparty-unpost-fs8](https://user-images.githubusercontent.com/241032/129635368-3afa6634-c20f-418c-90dc-ec411f3b3897.png) ![copyparty-unpost-fs8](https://user-images.githubusercontent.com/241032/129635368-3afa6634-c20f-418c-90dc-ec411f3b3897.png)
you can undo/delete uploads within `--unpost` seconds (default 12 hours) if the server is running with `-e2d` you can unpost even if you don't have regular move/delete access, however only for files uploaded within the past `--unpost` seconds (default 12 hours) and the server must be running with `-e2d`
## file manager ## file manager
if you have the required permissions, you can cut/paste, rename, and delete files/folders cut/paste, rename, and delete files/folders (if you have permission)
you can move files across browser tabs (cut in one tab, paste in another) you can move files across browser tabs (cut in one tab, paste in another)
## batch rename ## batch rename
![batch-rename-fs8](https://user-images.githubusercontent.com/241032/128434204-eb136680-3c07-4ec7-92e0-ae86af20c241.png)
select some files and press F2 to bring up the rename UI select some files and press F2 to bring up the rename UI
![batch-rename-fs8](https://user-images.githubusercontent.com/241032/128434204-eb136680-3c07-4ec7-92e0-ae86af20c241.png)
quick explanation of the buttons, quick explanation of the buttons,
* `[✅ apply rename]` confirms and begins renaming * `[✅ apply rename]` confirms and begins renaming
* `[❌ cancel]` aborts and closes the rename window * `[❌ cancel]` aborts and closes the rename window
@ -432,6 +451,8 @@ the metadata keys you can use in the format field are the ones in the file-brows
## markdown viewer ## markdown viewer
and there are *two* editors
![copyparty-md-read-fs8](https://user-images.githubusercontent.com/241032/115978057-66419080-a57d-11eb-8539-d2be843991aa.png) ![copyparty-md-read-fs8](https://user-images.githubusercontent.com/241032/115978057-66419080-a57d-11eb-8539-d2be843991aa.png)
* the document preview has a max-width which is the same as an A4 paper when printed * the document preview has a max-width which is the same as an A4 paper when printed
@ -446,6 +467,8 @@ the metadata keys you can use in the format field are the ones in the file-brows
## searching ## searching
search by size, date, path/name, mp3-tags, ...
![copyparty-search-fs8](https://user-images.githubusercontent.com/241032/129635365-c0ff2a9f-0ee5-4fc3-8bb6-006033cf67b8.png) ![copyparty-search-fs8](https://user-images.githubusercontent.com/241032/129635365-c0ff2a9f-0ee5-4fc3-8bb6-006033cf67b8.png)
when started with `-e2dsa` copyparty will scan/index all your files. This avoids duplicates on upload, and also makes the volumes searchable through the web-ui: when started with `-e2dsa` copyparty will scan/index all your files. This avoids duplicates on upload, and also makes the volumes searchable through the web-ui:
@ -461,6 +484,8 @@ add the argument `-e2ts` to also scan/index tags from music files, which brings
# server config # server config
## file indexing
file indexing relies on two databases, the up2k filetree (`-e2d`) and the metadata tags (`-e2t`). Configuration can be done through arguments, volume flags, or a mix of both. file indexing relies on two databases, the up2k filetree (`-e2d`) and the metadata tags (`-e2t`). Configuration can be done through arguments, volume flags, or a mix of both.
through arguments: through arguments:
@ -490,7 +515,7 @@ if you set `--no-hash`, you can enable hashing for specific volumes using flag `
## upload rules ## upload rules
you can set upload rules using volume flags, some examples: set upload rules using volume flags, some examples:
* `:c,sz=1k-3m` sets allowed filesize between 1 KiB and 3 MiB inclusive (suffixes: b, k, m, g) * `:c,sz=1k-3m` sets allowed filesize between 1 KiB and 3 MiB inclusive (suffixes: b, k, m, g)
* `:c,nosub` disallow uploading into subdirectories; goes well with `rotn` and `rotf`: * `:c,nosub` disallow uploading into subdirectories; goes well with `rotn` and `rotf`:
@ -509,7 +534,9 @@ you can also set transaction limits which apply per-IP and per-volume, but these
## compress uploads ## compress uploads
files can be autocompressed on upload, either on user-request (if config allows) or forced by server-config files can be autocompressed on upload
compression is either on user-request (if config allows) or forced by server-config
* volume flag `gz` allows gz compression * volume flag `gz` allows gz compression
* volume flag `xz` allows lzma compression * volume flag `xz` allows lzma compression
@ -530,6 +557,8 @@ some examples,
## database location ## database location
can be stored in-volume (default) or elsewhere
copyparty creates a subfolder named `.hist` inside each volume where it stores the database, thumbnails, and some other stuff copyparty creates a subfolder named `.hist` inside each volume where it stores the database, thumbnails, and some other stuff
this can instead be kept in a single place using the `--hist` argument, or the `hist=` volume flag, or a mix of both: this can instead be kept in a single place using the `--hist` argument, or the `hist=` volume flag, or a mix of both:
@ -543,6 +572,8 @@ note:
## metadata from audio files ## metadata from audio files
set `-e2t` to index tags on upload
`-mte` decides which tags to index and display in the browser (and also the display order), this can be changed per-volume: `-mte` decides which tags to index and display in the browser (and also the display order), this can be changed per-volume:
* `-v ~/music::r:c,mte=title,artist` indexes and displays *title* followed by *artist* * `-v ~/music::r:c,mte=title,artist` indexes and displays *title* followed by *artist*
@ -566,6 +597,8 @@ see the beautiful mess of a dictionary in [mtag.py](https://github.com/9001/copy
## file parser plugins ## file parser plugins
provide custom parsers to index additional tags
copyparty can invoke external programs to collect additional metadata for files using `mtp` (either as argument or volume flag), there is a default timeout of 30sec copyparty can invoke external programs to collect additional metadata for files using `mtp` (either as argument or volume flag), there is a default timeout of 30sec
* `-mtp .bpm=~/bin/audio-bpm.py` will execute `~/bin/audio-bpm.py` with the audio file as argument 1 to provide the `.bpm` tag, if that does not exist in the audio metadata * `-mtp .bpm=~/bin/audio-bpm.py` will execute `~/bin/audio-bpm.py` with the audio file as argument 1 to provide the `.bpm` tag, if that does not exist in the audio metadata
@ -586,6 +619,8 @@ copyparty can invoke external programs to collect additional metadata for files
# browser support # browser support
TLDR: yes
![copyparty-ie4-fs8](https://user-images.githubusercontent.com/241032/118192791-fb31fe00-b446-11eb-9647-898ea8efc1f7.png) ![copyparty-ie4-fs8](https://user-images.githubusercontent.com/241032/118192791-fb31fe00-b446-11eb-9647-898ea8efc1f7.png)
`ie` = internet-explorer, `ff` = firefox, `c` = chrome, `iOS` = iPhone/iPad, `Andr` = Android `ie` = internet-explorer, `ff` = firefox, `c` = chrome, `iOS` = iPhone/iPad, `Andr` = Android
@ -634,6 +669,8 @@ quick summary of more eccentric web-browsers trying to view a directory index:
# client examples # client examples
interact with copyparty using non-browser clients
* javascript: dump some state into a file (two separate examples) * javascript: dump some state into a file (two separate examples)
* `await fetch('https://127.0.0.1:3923/', {method:"PUT", body: JSON.stringify(foo)});` * `await fetch('https://127.0.0.1:3923/', {method:"PUT", body: JSON.stringify(foo)});`
* `var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://127.0.0.1:3923/msgs?raw'); xhr.send('foo');` * `var xhr = new XMLHttpRequest(); xhr.open('POST', 'https://127.0.0.1:3923/msgs?raw'); xhr.send('foo');`
@ -676,7 +713,9 @@ quick outline of the up2k protocol, see [uploading](#uploading) for the web-clie
# performance # performance
defaults are good for most cases, don't mind the `cannot efficiently use multiple CPU cores` message, it's very unlikely to be a problem defaults are good for most cases
you can ignore the `cannot efficiently use multiple CPU cores` message, it's very unlikely to be a problem
below are some tweaks roughly ordered by usefulness: below are some tweaks roughly ordered by usefulness:
@ -693,11 +732,14 @@ below are some tweaks roughly ordered by usefulness:
# dependencies # dependencies
mandatory deps:
* `jinja2` (is built into the SFX) * `jinja2` (is built into the SFX)
## optional dependencies ## optional dependencies
install these to enable bonus features
enable music tags: enable music tags:
* either `mutagen` (fast, pure-python, skips a few tags, makes copyparty GPL? idk) * either `mutagen` (fast, pure-python, skips a few tags, makes copyparty GPL? idk)
* or `ffprobe` (20x slower, more accurate, possibly dangerous depending on your distro and users) * or `ffprobe` (20x slower, more accurate, possibly dangerous depending on your distro and users)
@ -730,7 +772,7 @@ these are standalone programs and will never be imported / evaluated by copypart
# sfx # sfx
currently there are two self-contained "binaries": there are two self-contained "binaries":
* [copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py) -- pure python, works everywhere, **recommended** * [copyparty-sfx.py](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.py) -- pure python, works everywhere, **recommended**
* [copyparty-sfx.sh](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.sh) -- smaller, but only for linux and macos, kinda deprecated * [copyparty-sfx.sh](https://github.com/9001/copyparty/releases/latest/download/copyparty-sfx.sh) -- smaller, but only for linux and macos, kinda deprecated
@ -741,6 +783,8 @@ pls note that `copyparty-sfx.sh` will fail if you rename `copyparty-sfx.py` to `
## sfx repack ## sfx repack
reduce the size of an sfx by disabling features
if you don't need all the features, you can repack the sfx and save a bunch of space; all you need is an sfx and a copy of this repo (nothing else to download or build, except if you're on windows then you need msys2 or WSL) if you don't need all the features, you can repack the sfx and save a bunch of space; all you need is an sfx and a copy of this repo (nothing else to download or build, except if you're on windows then you need msys2 or WSL)
* `525k` size of original sfx.py as of v0.11.30 * `525k` size of original sfx.py as of v0.11.30
* `315k` after `./scripts/make-sfx.sh re no-ogv` * `315k` after `./scripts/make-sfx.sh re no-ogv`
@ -784,7 +828,7 @@ pip install black bandit pylint flake8 # vscode tooling
## just the sfx ## just the sfx
unless you need to modify something in the web-dependencies, it's faster to grab those from a previous release: grab the web-dependencies from a previous sfx (unless you need to modify something in those):
```sh ```sh
rm -rf copyparty/web/deps rm -rf copyparty/web/deps
@ -804,7 +848,7 @@ then build the sfx using any of the following examples:
## complete release ## complete release
also builds the sfx so disregard the sfx section above also builds the sfx so skip the sfx section above
in the `scripts` folder: in the `scripts` folder:

2
docs/notes.sh
View file

@ -157,7 +157,7 @@ brew install python@2
pip install virtualenv pip install virtualenv
# readme toc # readme toc
cat README.md | awk '!/^#/{next} {lv=length($1);sub(/[^ ]+ /,"");bab=$0;gsub(/ /,"-",bab)} {printf "%" ((lv-1)*4+1) "s [%s](#%s)\n", "*",$0,bab}' cat README.md | awk 'function pr() { if (!h) {return}; if (/^ *[*!#]/||!s) {printf "%s\n",h;h=0;return}; if (/.../) {printf "%s - %s\n",h,$0;h=0}; }; /^#/{s=1;pr()} /^#* *(file indexing|install on android|dev env setup|just the sfx|complete release|optional gpl stuff)|`$/{s=0} /^#/{lv=length($1);sub(/[^ ]+ /,"");bab=$0;gsub(/ /,"-",bab); h=sprintf("%" ((lv-1)*4+1) "s [%s](#%s)", "*",$0,bab);next} !h{next} {sub(/:$/,"")} {pr()}' > toc; grep -E '^## readme toc' -B1000 -A2 <README.md >p1; grep -E '^## quickstart' -B2 -A999999 <README.md >p2; (cat p1; grep quickstart -A1000 <toc; cat p2) >README.md
# fix firefox phantom breakpoints, # fix firefox phantom breakpoints,
# suggestions from bugtracker, doesnt work (debugger is not attachable) # suggestions from bugtracker, doesnt work (debugger is not attachable)