Commit Graph

39 Commits

Author SHA1 Message Date
Jonathan Lebon
11218fead5 README.md: Keep it short and sweet
Let's keep the bulk of the documentation in the README in the docs site
landing page instead. That way, changing text there doesn't require
changing it in two places.
2020-10-01 14:29:37 -04:00
Timothée Ravier
a3080a42bf docs: Unify and update README and Index page 2020-10-01 12:01:25 -04:00
Colin Walters
d34e41cc05 Clarify license situation to include GPLv2, relicense Rust code
We have contacted all contributors to the code in `rust/` and
that code is now all relicensed under the "standard Rust license"
of `Apache 2.0 OR MIT`.

[Due to an accident](https://github.com/projectatomic/rpm-ostree/issues/1890),
some GPLv2+ code was imported in the C side, and we're unlikely to
easily change that now.  Make this more official by adding the GPLv2.

I'd like to go through the C code and add SPDX and possibly investigate
relicensing some of the GPLv2+ code to LGPLv2+ but, not right now.

For a bit more about Rust and SPDX, see [this issue](https://github.com/rust-lang/cargo/issues/2039).

Closes: https://github.com/projectatomic/rpm-ostree/issues/1890

Closes: #1897
Approved by: jlebon
2019-09-05 20:49:18 +00:00
Colin Walters
80fd2e883b README.md: Add a "why" section, update background.md
Point at FCOS and not Project Atomic.  Add an inline "Why"
section since people will want to know that right away.

(An great thing about Github is the prevalence it gives to `README.md`;
 projects should use that as an "elevator pitch")

Drop outdated bits in `background.md`.

Closes: #1895
Approved by: jlebon
2019-09-04 20:09:13 +00:00
Matthew Leeds
b11d1fc1e3 README.md: Fix youtube link
Closes: #1335
Approved by: cgwalters
2018-04-14 15:24:54 +00:00
Colin Walters
88324984ab README.md: Update "projects using rpm-ostree" section
Mention Kube over Docker, and also drop the "immutable" bit as I think it's a
misleading term.

Closes: #1264
Approved by: jlebon
2018-02-20 15:42:35 +00:00
Colin Walters
f0e381392e README.md: Add arch diagram, tweak wording, add talk links
There's a lot more we could do here but I think the architecture
diagram in particular helps a lot.

Closes: #1245
Approved by: jlebon
2018-02-14 17:36:29 +00:00
Eduardo Mayorga
d520d0b368 README.md: libhif is now called libdnf
Closes: #628
Approved by: jlebon
2017-02-16 15:40:20 +00:00
Colin Walters
64c6f8d906 docs: Separate README.md and docs index, elaborate more
Have the index page be rationale/comparison for now.

Closes: #370
Approved by: jlebon
2016-07-16 02:16:09 +00:00
Jonathan Lebon
7cebf962c1 docs: fix ostree and CONTRIBUTING.md links
- Update links to OSTree documentation.
- Fix CONTRIBUTING.md by making symlink in top dir.

Closes: #387
Approved by: cgwalters
2016-07-12 15:46:53 +00:00
Colin Walters
125c482b1d Switch to using libhif as a git submodule
So I was trying to hack on my host's copy of rpm-ostree inside a pet
docker container, but ran into a conflict with libhif since dnf uses
it.  I think we basically need to *always* build the bundled path,
rather than what I'm doing with CAHC and FADC where it's built as a
regular RPM.

It's not really sustainable right now for us to have both bundled and
not-bundled build paths - and we need to support co-installation with
dnf.

Another major issue is that we want to version lock with libhif -
right now our CI and both CAHC/FADC track libhif master, but that
means everything breaks if libhif breaks and we don't immediately
port.

git submodules solve all of these problems - the same as we're doing
with libglnx.

libglnx is *designed* for use as a git submodule, where as libhif
needs to support being both bundled and not-bundled.  So we end up
with some hacks on our side, but I think it's all not too bad.  I've
marked build rules with `# bundled libhif` so we know where to find
them later when libhif is stable.

Closes: #357
Approved by: jlebon
2016-06-30 14:27:55 +00:00
Gerard Braad
350718ffd5 Correct location of document link
Closes: #352
Approved by: giuseppe
2016-06-26 12:07:47 +00:00
Jonathan Lebon
fdbe28b964 docs: fix README.md and add HACKING.md
Add a HACKING.md document detailing how to get started and test
rpm-ostree using the vagrant box.

Fix the CONTRIBUTING.md link and add a link to HACKING.md in README.md.

Closes: #344
Approved by: cgwalters
2016-06-23 00:05:09 +00:00
Colin Walters
b1bb193871 README/docs: A few more links around composes
Mostly just to test Homu again.

Closes: #288
Approved by: cgwalters
2016-05-26 18:48:27 +00:00
Colin Walters
603180bcf2 docs: Point compose server intro to CentOS
We should make this less abstract and rather point people directly at
the CentOS bits as it's more likely to be a real-world useful example
and produce something they want.

Fix a few other typos and bits.

Closes: #279
Approved by: miabbott
2016-05-03 14:29:59 +00:00
Colin Walters
dea5040e41 README: Elaborate a bit on building
Pull request: #244
Approved by: jlebon
2016-03-22 18:46:52 +00:00
Colin Walters
d06c5d694b docs: Start using mkdocs
Matching https://git.gnome.org/browse/ostree/commit/docs/CONTRIBUTING.md?id=64ebe2b82ac25f1933f39a5cf8a24a5e0096cf6f
2016-03-09 11:10:58 -05:00
Jason Brooks
3e4963a9e8 remove erroneous rpm-ostree equals /usr/bin/atomic reference 2015-05-28 11:51:39 -07:00
Jonathan Dowland
bd834f1f90 README.md: Fix minor typo 2015-03-09 11:37:56 -04:00
Colin Walters
c5d3e9cb0a doc: More updates, note atomic status, flesh out tradeoffs 2014-11-01 10:33:39 -04:00
Colin Walters
9e6231407c README.md: Add more docs 2014-10-31 14:39:57 -04:00
Colin Walters
66b0737720 README.md: Update a bit 2014-10-30 17:04:45 -04:00
Colin Walters
9c81a83e14 README.md: We no longer need nss-altfiles on the host 2014-07-18 16:16:19 -04:00
Colin Walters
f3b393ce03 README.md: Note that we work on the client as well 2014-06-20 11:02:24 -04:00
Colin Walters
35dc098c31 README.md: Add a note about HTTP proxy 2014-06-05 08:59:06 -04:00
Colin Walters
7ba5e4cb09 README.md: Link to -toolbox now 2014-05-26 17:36:45 -04:00
Colin Walters
5ed249c755 docs: Update rename of treecompose -> compose tree 2014-05-26 15:11:38 -04:00
Colin Walters
ed113d4c0c README.md: Update for split repositories 2014-05-10 13:58:29 -04:00
Colin Walters
0ad262b2c4 treecompose: Remove internal caching, require --repo argument
It's a lot clearer if the inputs, outputs, and cache state are cleanly
separated.  At least the "lorax" tool relies on a local HTTP cache
instead of keeping around the yum repos - let's do the same.

This commit causes treecompose to require a --repo argument, and it
also gains an optional --proxy argument.
2014-05-03 06:55:35 -04:00
Colin Walters
188c74e410 README.md: Update with more recent instructions 2014-04-04 12:19:02 -04:00
James Antill
d4972ede5d Minor documentation fix for running rpm-ostree. 2014-03-12 16:34:40 -04:00
Colin Walters
9aa1bdb494 README.md: Fix code syntax 2014-03-07 18:08:57 -05:00
Colin Walters
d792939bb3 README.md: Update for previous commit 2014-02-23 17:06:06 -05:00
Colin Walters
3a63393a81 README.md: Update installation/usage to reflect new treefile reality 2014-02-12 19:58:58 -05:00
Colin Walters
0c6c8f2e8f README: Add note about setting up webserver 2014-02-04 11:37:05 -05:00
Colin Walters
9d681bc368 README.md: Update with short instructions on setting up your own builder 2014-02-03 18:04:06 -05:00
Colin Walters
94d62929fc README: Note we require selinux=0 currently 2013-12-23 15:00:31 -05:00
Colin Walters
5f51e32459 README.md: Syntax and misc content fixes 2013-12-22 18:06:09 -05:00
Colin Walters
02c2e619d7 README.md: Move to toplevel 2013-12-22 10:59:00 -05:00