Commit Graph

33 Commits

Author SHA1 Message Date
Jonathan Lebon
053efeb23a docs: Add "Hello World" example
Let's get practical faster in the manual and have a simple "Hello World"
example right off the bat to hopefully make it easier to grok how OSTree
works.

Also some minor tweaks on wording around comparisons to git.

Closes: #1581
Approved by: cgwalters
2018-05-08 14:49:59 +00:00
Colin Walters
490cfbe226 README: Tweak licensing description
Basically it wasn't clear that the man pages and API doc
remain LGPLv2.

Closes: https://github.com/ostreedev/ostree/issues/1456

Closes: #1574
Approved by: smcv
2018-05-04 11:29:44 +00:00
Colin Walters
776ce5cc6a README.md: Fix docs link to COPYING
Because `README.md` also gets rendered into the docs, we need
to link directly to github.

Closes: https://github.com/ostreedev/ostree/issues/1534

Closes: #1554
Approved by: jlebon
2018-04-30 14:33:37 +00:00
Colin Walters
85c31647cb docs: Dual license under CC BY-SA and the GFDL
This will allow the text to be used in Wikipedia for example; it
also just makes more sense for documentation than the LGPLv2+.

Closes: #1431

Closes: #1432
Approved by: jlebon
2018-02-05 14:31:16 +00:00
Sam Thursfield
8d6b30c381 README.md: Link to BuildStream
This is an example of a tool using libostree to cache and share
build results.

Closes: #1360
Approved by: cgwalters
2017-12-04 18:26:51 +00:00
Colin Walters
7b3e55a3f4 docs/build: s/libOSTree/libostree/
I find "libOSTree" awkward to type and really to look at. Let's be nicer on
people's pinky fingers and eyes and drop it all down to lowercase.

Closes: #1093
Approved by: jlebon
2017-08-18 17:51:09 +00:00
Guy Shapiro
aa63d0e0c5 Documentation: README: Remove deprecated wiki link
The old wiki only contains link back to readthedocs.
The link to is useless.
Closes: #1050
Approved by: cgwalters
2017-08-03 13:00:26 +00:00
Colin Walters
7d7ab92a05 README.md: Add more/clean up links to consuming projects
Add meta-updater and QtOTA, and delete OpenEmbedded since it's implied by the
first two. Merge rpm-ostree + Atomic Host since they're close. Clarify
gnome-continuous a bit.

Closes: #700
Approved by: jlebon
2017-02-21 16:34:14 +00:00
Colin Walters
7803fe1d60 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
2017-02-02 17:47:43 +00:00
Matthew Leeds
203c0c88db README: Fix broken link
Closes: #397
Approved by: cgwalters
2016-07-14 20:32:41 +00:00
Colin Walters
574805b0f3 README: x/xdg-app/flatpak/
I'm mostly just testing some Homu updates.

Closes: #299
Approved by: cgwalters
2016-05-13 14:01:37 +00:00
Micah Abbott
0b068c668a docs: Cleanup Markdown
I was going through the new version of the docs and noticed a few
problems.  Mostly URLs that aren't linked, extra whitespace, and a few
mis-spellings.

I ran the files through `aspell check` and made some manual changes
myself.

These changes were tested locally with `mkdocs serve`
2016-03-16 15:02:18 -04:00
Colin Walters
0c15c9d6dd README.md: Update to link to Read The Docs, describe a bit better 2016-02-08 14:35:24 +01:00
Colin Walters
64ebe2b82a Rewrite manual in mkdocs
I don't much like Docbook (and am considering converting the man pages
too), but let's start with the manual.

I looked at various documentation generators (there are a lot), and
I had a few requirements:

 - Markdown
 - Packaged in Fedora
 - Suitable for upload to a static webserver

`mkdocs` seems to fit the bill.
2016-01-28 09:31:37 -05:00
Colin Walters
cd6eac2ce9 README: Attempt to flesh out more, start moving docs from wiki
I'd like to migrate content from the GNOME wiki, as frankly the wiki
is crap.  Markdown in git is better in every way.

Start by fleshing out the README.md to be more useful.
2015-07-28 18:39:43 -04:00
Giuseppe Scrivano
42edb6f91b README.md: fix typo
Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2015-04-21 23:05:23 +02:00
Colin Walters
8724adc193 README.md: Note make check 2015-03-10 21:51:20 -04:00
Colin Walters
b8a06c11f6 README.md: Add a quick blurb on style 2014-12-07 17:19:42 -05:00
Colin Walters
2731155950 README.md: Mention patches and test suite 2014-11-30 13:23:06 -05:00
Colin Walters
35c1fe324f README: Just link to wiki, move most of it to README-historical.md 2014-01-20 18:00:09 -05:00
Federico Mena Quintero
49dfd6c958 Add a Development section to the README
Put in links to the wiki and the git repository for OSTree
2012-04-24 09:49:21 -04:00
Colin Walters
2ecc0cdef1 README.md: Note existence of wiki page 2012-04-18 20:36:16 -04:00
Colin Walters
6647050978 Update READMEs a bit 2012-02-03 08:42:07 -05:00
Colin Walters
5e7183d8b7 README: Link to schroot and git-annex 2011-11-10 15:21:28 -05:00
Colin Walters
45edb34dc9 README.md: Link to IPS 2011-11-10 09:43:22 -05:00
Colin Walters
fab085dcaf README: Make package discussion more useful 2011-11-09 07:56:43 -05:00
Colin Walters
b27df6fd72 "Hacktree" is now known as "OSTree"
It just sounds better.
2011-10-18 14:44:48 -04:00
Colin Walters
aaae116f8e README: Some notes on BTRFS 2011-10-17 11:08:25 -04:00
Colin Walters
d32dd476f7 README: Elaborate and clarify some more 2011-10-17 09:39:27 -04:00
Colin Walters
25f06eb52c README.md: Some more notes about upgrading 2011-10-16 14:24:56 -04:00
Colin Walters
130e277c5d README.md: Some more thoughts 2011-10-16 14:18:20 -04:00
Colin Walters
d37d5b0c25 README.md: Some tweaks 2011-10-16 11:17:59 -04:00
Colin Walters
4c58d2f0cb Have an introductory README.md that makes sense
Skip the "how do we build" for now.
2011-10-15 16:46:33 -04:00