Commit Graph

8 Commits

Author SHA1 Message Date
eadler
24b115efc9 README: add generic notes about GENERIC and NOTES
Inform new users what GENERIC and NOTES are. These are useful for people
perusing the tree without a great deal of specific fbsd knowledge.
See discussion of r334073 for further motivation.

Requested by:	jhb
2018-06-17 19:44:24 +00:00
eadler
6f0717b5a3 README: Reduce the textdump; describe the project
Rework the README to make it a little easier for new users. This is the
first file many will see when persuing the FreeBSD source code so

- remove some of the text describes how to build. This is better covered
in the linked documentation.
- add a small blurb for what FreeBSD is. Some users might find this
document through features such as github search so they may not even
know what the project is

generally, gear this file for the new, accidental, or casual user rather
than towards someone seeking fuller documentation.
2018-05-23 04:09:01 +00:00
trasz
f568d08f7d Fix README.md formatting.
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
2018-03-02 14:42:08 +00:00
markj
142be8f0c4 Document the sys/boot -> stand move in hier.7 and the top-level README.
Reviewed by:	imp
Differential Revision:	https://reviews.freebsd.org/D13353
2017-12-03 20:36:36 +00:00
eadler
a3284289af Correct the URLs for both READMEs for tracking src
Previously there were two different URLs in two
different READMEs, neither of which went anywhere.
2017-10-29 20:29:31 +00:00
eadler
45275e3a26 Update several more URLs
- Primarily http -> https
- Primarily FreeBSD project URLs
2017-10-29 08:17:03 +00:00
emaste
64c856ed35 Remove hard line breaks from README.md
This is rendered with variable-width formatting and a proportional font,
so hard line breaks before 80 cols are undesired.
2017-03-01 15:39:58 +00:00
imp
ef2acd7183 Create README.md file for viewing on github.
This is a lightly edited README using github's MARKDOWN.

Submitted by:	Johan <johan2422@gmail.com>
Pull Request:	https://github.com/freebsd/freebsd/pull/56
2017-03-01 05:05:05 +00:00