OILS / doc / release-index.md View on Github | oilshell.org

96 lines, 76 significant
1---
2css_files: web/base.css web/release-index.css
3all_docs_url: -
4version_url: -
5---
6
7Oils 0.21.0
8===========
9
10<!-- NOTE: This file is published to /release/$VERSION/index.html -->
11
12<span class="date">
13<!-- REPLACE_WITH_DATE -->
14</span>
15
16This is the home page for version 0.21.0 of Oils, a Unix shell. To use it,
17
181. Download a source tarball.
192. Build it and do a "smoke test", as described in [INSTALL][].
20
21These steps take 30 to 60 seconds on most machines. After installation, see
22[Getting Started](doc/getting-started.html).
23
24The associated **[quality page](quality.html)** shows test results, metrics,
25and benchmarks.
26
27[INSTALL]: doc/INSTALL.html
28
29## Download
30
31<!-- REPLACE_WITH_DOWNLOAD_LINKS -->
32
33**[Oils Packaging Guidelines]($wiki)**:
34
35- The `oils-for-unix` tarball is the fast shell in C++, completed in
36 2024. The distro package should be called `oils-for-unix`.
37- The `oil` tarball is the slow reference interpreter based on CPython.
38 - Don't rename old distro packages. They can remain `oil`.
39 - It's not worth packaging `oil` in new distros. It may be removed at some
40 point.
41- The project is now called **Oils**, or [Oils for
42 Unix](https://www.oilshell.org/blog/2023/03/rename.html). There is no more
43 `oil`!
44
45## What's New
46
47- Details are in the [raw git change log](changelog.html). Not all changes
48 affect the release tarball.
49- I sometimes write a [release announcement](announcement.html) with a
50 high-level description of changes.
51
52## Documentation
53
54These docs are **ready to read**:
55
56- [Getting Started](doc/getting-started.html)
57- [FAQ on Documentation](doc/faq-doc.html). **Look here if you can't find
58 something.**
59- OSH:
60 - [Known Differences Between OSH and Other Shells](doc/known-differences.html)
61 | [Quirks](doc/quirks.html)
62 | [Tracing Execution](doc/xtrace.html)
63 | [Headless Mode](doc/headless.html)
64- YSH:
65 - Intro: [A Tour of YSH](doc/ysh-tour.html)
66 | [A Feel For YSH Syntax](doc/syntax-feelings.html)
67 | [YSH vs. Shell Idioms](doc/idioms.html) and [Shell Idioms](doc/shell-idioms.html)
68 | [What Breaks When You Upgrade to YSH](doc/upgrade-breakage.html)
69 | [YSH Language FAQ](doc/ysh-faq.html)
70 - Comparisons: [YSH vs. Shell](doc/ysh-vs-shell.html) | [YSH Expressions vs.
71 Python](doc/ysh-vs-python.html)
72 - Features: [Egg Expressions (YSH Regexes)](doc/eggex.html)
73 | [YSH Regex API](doc/ysh-regex-api.html)
74 | [Guide to Procs and Funcs](doc/proc-func.html)
75 | [YSH Fixes Shell's Error Handling](doc/error-handling.html)
76 | [Simple Word Evaluation](doc/simple-word-eval.html)
77 | [Variable Declaration, Mutation, and Scope](doc/variables.html)
78 | [Hay - Custom Languages for Unix Systems](doc/hay.html)
79- Data Languages:
80 - [JSON](doc/json.html) | [J8 Notation](doc/j8-notation.html)
81- Language Design:
82 - [Syntactic Concepts](doc/syntactic-concepts.html)
83 | [Command vs. Expression Mode](doc/command-vs-expression-mode.html)
84 | [Language Influences](doc/language-influences.html)
85 - Notes: [Novelties in OSH and YSH](doc/novelties.html) | [Warts](doc/warts.html)
86- Reference:
87 - [Oils Error Catalog, With Hints](doc/error-catalog.html)
88
89More:
90
91- [**All Docs**](doc/) about Oils (in progress).
92 - Including the [**Oils Reference**](doc/ref/index.html) (in progress)
93- [Github Wiki for oilshell/oil](https://github.com/oilshell/oil/wiki). The
94 [Oil Deployments](https://github.com/oilshell/oil/wiki/Oil-Deployments) wiki
95 page has other ways of getting Oils. These versions may not be up-to-date.
96