Commit Graph

22 Commits

Author SHA1 Message Date
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