summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Added Fedora Kinoite linkŠimon (Simon) Rataj2021-11-031-1/+2
|
* docs: Change IRC channel to libera.chat from freenodePhilip Withnall2021-06-011-1/+1
| | | | | | Freenode appears to be imploding. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
* *: rename master branch to mainTimothée Ravier2021-05-071-2/+2
|
* README.md: Fix contributing link, add contact sectionColin Walters2021-02-161-1/+7
| | | | Came up on #fedora-iot channel.
* README.md: Also link apt2ostreeColin Walters2021-01-311-0/+3
| | | | Since the topic of Debian+ostree-for-host comes up fairly often.
* README: Fix typos of FlatpakPhaedrus Leeds2020-12-011-7/+7
|
* README.md: Add Apertis and GNOME OSJavier Jardón2020-12-011-0/+7
|
* README: Update and mention new docsTimothée Ravier2020-10-021-26/+13
|
* README.md: Fix link to CONTRIBUTING.mdNEPO2020-06-101-1/+1
| | | | We should link to the target and not the symlink.
* README.md: Tweak text about BuildStreamSam Thursfield2019-12-011-2/+1
| | | | | | BuildStream no longer uses libostree internally (see https://gitlab.com/BuildStream/buildstream/issues/387). It still has first class support for interoperating with libostree repos.
* README.md: Rework "projects using" sectionColin Walters2019-08-071-23/+45
| | | | | | | | | | | | | Update this to mention the 3 Fedora derivatives, RHEL CoreOS etc. Create 3 sections: - OS/Distributions - build tools - rpm-ostree/flatpak Closes: #1895 Approved by: dustymabe
* README: update link to ostree-rsFelix Krull2019-05-171-1/+1
| | | | | Closes: #1860 Approved by: jlebon
* README: add note about Liri OSMicah Abbott2019-01-151-1/+4
| | | | | Closes: #1802 Approved by: rfairley
* README: Add bindings sectionColin Walters2018-10-231-0/+16
| | | | | | | | Since rust-libostree now exists too, let's make sure people know about it. Closes: #1762 Approved by: jlebon
* docs: Add "Hello World" exampleJonathan Lebon2018-05-081-3/+3
| | | | | | | | | | | 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
* README: Tweak licensing descriptionColin Walters2018-05-041-2/+6
| | | | | | | | | | 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
* README.md: Fix docs link to COPYINGColin Walters2018-04-301-1/+4
| | | | | | | | | | 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
* docs: Dual license under CC BY-SA and the GFDLColin Walters2018-02-051-0/+7
| | | | | | | | | | 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
* README.md: Link to BuildStreamSam Thursfield2017-12-041-0/+4
| | | | | | | | This is an example of a tool using libostree to cache and share build results. Closes: #1360 Approved by: cgwalters
* docs/build: s/libOSTree/libostree/Colin Walters2017-08-181-16/+18
| | | | | | | | 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
* Documentation: README: Remove deprecated wiki linkGuy Shapiro2017-08-031-3/+0
| | | | | | | The old wiki only contains link back to readthedocs. The link to is useless. Closes: #1050 Approved by: cgwalters
* README.md: Add more/clean up links to consuming projectsColin Walters2017-02-211-18/+28
| | | | | | | | | 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
* Rename to libOSTreeColin Walters2017-02-021-10/+16
| | | | | | | | | | | | | | | | | | | | | | | | | 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
* README: Fix broken linkMatthew Leeds2016-07-141-1/+1
| | | | | Closes: #397 Approved by: cgwalters
* README: x/xdg-app/flatpak/Colin Walters2016-05-131-1/+1
| | | | | | | I'm mostly just testing some Homu updates. Closes: #299 Approved by: cgwalters
* docs: Cleanup MarkdownMicah Abbott2016-03-161-2/+2
| | | | | | | | | | | 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`
* README.md: Update to link to Read The Docs, describe a bit betterColin Walters2016-02-081-12/+28
|
* Rewrite manual in mkdocsColin Walters2016-01-281-2/+2
| | | | | | | | | | | | | | 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.
* README: Attempt to flesh out more, start moving docs from wikiColin Walters2015-07-281-117/+60
| | | | | | | 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.
* README.md: fix typoGiuseppe Scrivano2015-04-211-1/+1
| | | | Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
* README.md: Note make checkColin Walters2015-03-101-1/+5
|
* README.md: Add a quick blurb on styleColin Walters2014-12-071-0/+95
|
* README.md: Mention patches and test suiteColin Walters2014-11-301-0/+23
|
* README: Just link to wiki, move most of it to README-historical.mdColin Walters2014-01-201-449/+8
|
* Add a Development section to the READMEFederico Mena Quintero2012-04-241-0/+11
| | | | Put in links to the wiki and the git repository for OSTree
* README.md: Note existence of wiki pageColin Walters2012-04-181-0/+4
|
* Update READMEs a bitColin Walters2012-02-031-38/+53
|
* README: Link to schroot and git-annexColin Walters2011-11-101-0/+9
|
* README.md: Link to IPSColin Walters2011-11-101-0/+6
|
* README: Make package discussion more usefulColin Walters2011-11-091-43/+22
|
* "Hacktree" is now known as "OSTree"Colin Walters2011-10-181-22/+53
| | | | It just sounds better.
* README: Some notes on BTRFSColin Walters2011-10-171-0/+35
|
* README: Elaborate and clarify some moreColin Walters2011-10-171-24/+45
|
* README.md: Some more notes about upgradingColin Walters2011-10-161-0/+14
|
* README.md: Some more thoughtsColin Walters2011-10-161-21/+34
|
* README.md: Some tweaksColin Walters2011-10-161-1/+21
|
* Have an introductory README.md that makes senseColin Walters2011-10-151-0/+293
Skip the "how do we build" for now.