summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2017-01-30 05:41:59 +0100
committerAtomic Bot <atomic-devel@projectatomic.io>2017-02-02 17:47:43 +0000
commit7803fe1d60f32f659555acf32a8812a45ab15792 (patch)
tree12f84c22c92b4c8fe51d3b3b97961c48a52c9222 /README.md
parentecf5c079ea90377c6791962a9c6083ad653d3d7c (diff)
downloadostree-7803fe1d60f32f659555acf32a8812a45ab15792.tar.gz
Rename to libOSTree
There are many motivating factors. The biggest is simply that at a practical level, the command line is not sufficient to build a real system. The docs say that it's a demo for the library. Let's make that more obvious, so people don't try to use `ostree admin upgrade` for their real systems, and also don't use e.g. `ostree commit` on the command line outside of test suites/quick hacking. This change will also help clarify the role of rpm-ostree, which we will likely be renamed to "nts". Then use of the term "ostree" will become much clearer. And similarly for other people writing upgraders, they can say they use libostree. I didn't try to change all of the docs and code at once, because it's going to lead to conflicts. The next big steps are: - Rename the github repo (github will inject a redirect) - Look at supporting a build where we don't do `ostree admin`, or at least it's only built for tests. We may want to split it off as a separate binary or so? That way people with their own upgraders don't need to ship it. Closes: #659 Approved by: jlebon
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 16 insertions, 10 deletions
diff --git a/README.md b/README.md
index 369a8925..f189ebc9 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,25 @@
-OSTree
+libOSTree
======
New! See the docs online at [Read The Docs (OSTree)](https://ostree.readthedocs.org/en/latest/ )
-----
-OSTree is a tool that combines a "git-like" model for committing and
-downloading bootable filesystem trees, along with a layer for
-deploying them and managing the bootloader configuration.
-
-OSTree is like git in that it checksums individual files and has a
-content-addressed-object store. It's unlike git in that it "checks
-out" the files via hardlinks, and they should thus be immutable.
-Therefore, another way to think of OSTree is that it's just a more
-polished version of
+This project is now known as "libOSTree", renamed from "OSTree"; the focus is on
+the shared library. However, in most of the rest of the documentation, we will
+use the term "OSTree", since it's slightly shorter, and changing all
+documentation at once is impractical. We expect to transition to the new name
+over time.
+
+libOSTree is a library and suite of command line tools that combines a
+"git-like" model for committing and downloading bootable filesystem trees, along
+with a layer for deploying them and managing the bootloader configuration.
+
+The core OSTree model is like git in that it checksums individual files and has
+a content-addressed-object store. It's unlike git in that it "checks out" the
+files via hardlinks, and they should thus be immutable. Therefore, another way
+to think of OSTree is that it's just a more polished version
+of
[Linux VServer hardlinks](http://linux-vserver.org/index.php?title=util-vserver:Vhashify&oldid=2285).
**Features:**