| 1 | Published Docs
|
| 2 | ==============
|
| 3 |
|
| 4 | This page links to docs that are ready to read.
|
| 5 |
|
| 6 | See [All Docs](index.html) for links to drafts.
|
| 7 |
|
| 8 | ## Good Places to Start
|
| 9 |
|
| 10 | - [Getting Started](getting-started.html)
|
| 11 | - [YSH Editor Support]($wiki) on the wiki.
|
| 12 | - [A Tour of YSH](ysh-tour.html)
|
| 13 | - [YSH vs. Shell Idioms](idioms.html)
|
| 14 | - [**Oils Reference**](ref/index.html) - underlies the [help][] builtin
|
| 15 | - [FAQ on Docs](faq-doc.html). **Look here if you can't find
|
| 16 | something**.
|
| 17 |
|
| 18 | Build/packaging:
|
| 19 |
|
| 20 | - [INSTALL](INSTALL.html). How do I install Oils? This text file is also in
|
| 21 | the `oils-for-unix` tarball.
|
| 22 | - [Oils Build `--help` Mirror](help-mirror.html)
|
| 23 | - [Portability](portability.html)
|
| 24 |
|
| 25 | [help]: ref/chap-builtin-cmd.html#help
|
| 26 |
|
| 27 | ## More
|
| 28 |
|
| 29 | OSH:
|
| 30 |
|
| 31 | - [Known Differences Between OSH and Other Shells](known-differences.html) |
|
| 32 | [Quirks](quirks.html) | [Headless Mode](headless.html) | [Shell
|
| 33 | Idioms](shell-idioms.html)
|
| 34 |
|
| 35 | YSH:
|
| 36 |
|
| 37 | - [A Feel For YSH Syntax](syntax-feelings.html) | [YSH Style
|
| 38 | Guide](style-guide.html) | [What Breaks When You Upgrade to
|
| 39 | YSH](upgrade-breakage.html) | [YSH Language FAQ](ysh-faq.html)
|
| 40 |
|
| 41 | - Comparisons: [YSH vs. Shell](ysh-vs-shell.html) | [YSH Expressions vs.
|
| 42 | Python](ysh-vs-python.html)
|
| 43 |
|
| 44 | - Features: [Egg Expressions (YSH Regexes)](eggex.html)
|
| 45 | | [YSH Regex API](ysh-regex-api.html)
|
| 46 | | [Guide to YSH Error Handling](ysh-error.html)
|
| 47 | | [Guide to Procs and Funcs](proc-func.html)
|
| 48 | | [YSH Fixes Shell's Error Handling](error-handling.html)
|
| 49 | | [Simple Word Evaluation](simple-word-eval.html)
|
| 50 | | [Variable Declaration, Mutation, and Scope](variables.html)
|
| 51 | | [Hay - Custom Languages for Unix Systems](hay.html)
|
| 52 |
|
| 53 | Data Languages:
|
| 54 |
|
| 55 | - [JSON](json.html) | [J8 Notation](j8-notation.html) | [BYO
|
| 56 | Protocols](byo.html)
|
| 57 |
|
| 58 | Language Design:
|
| 59 |
|
| 60 | - [Syntactic Concepts](syntactic-concepts.html)
|
| 61 | | [Command vs. Expression Mode](command-vs-expression-mode.html)
|
| 62 | | [Language Influences](language-influences.html)
|
| 63 | - Notes: [Novelties in OSH and YSH](novelties.html) | [Warts](warts.html)
|
| 64 |
|
| 65 | The Shared Oils Runtime
|
| 66 |
|
| 67 | - [Types in the Oils Runtime](types.html) | [Tracing Execution](xtrace.html)
|
| 68 |
|
| 69 | Reference:
|
| 70 |
|
| 71 | - [Oils Error Catalog, With Hints](error-catalog.html)
|
| 72 |
|
| 73 | For contributors:
|
| 74 |
|
| 75 | - [README.md](oils-repo/README.html). If you want to modify Oils, start here.
|
| 76 | We welcome contributions!
|
| 77 | - [Oils Repo Overview](repo-overview.html)
|
| 78 | - [mycpp/README](oils-repo/mycpp/README.html) - How we translate typed Python to
|
| 79 | C++.
|
| 80 | - [ul-table: Markdown Tables Without New Syntax](ul-table.html)
|