mirror/freebsd
1
0
Fork 0
mirror of https://git.FreeBSD.org/src.git synced 2024-11-26 07:55:01 +00:00
Code Issues Releases Activity
284,565 Commits 336 Branches 3,540 Tags 2 GiB
383d51d592
Commit Graph

21 Commits

Author SHA1 Message Date
Mitchell Horne
c34ffd6c8b README.md: link to the list of supported platforms 
It answers a question that someone might have when faced with the source
tree for the first time, and improves discoverability of the platforms
page.

Reviewed by:	emaste
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37179
 2022-11-01 12:20:55 -03:00
Mitchell Horne
f0e4e02110 hier(7): remove text describing /usr/src layout 
It poses a maintenance burden, since much of the information is
duplicated in the src tree's README.md file. Readers who are interested
enough in learning about the structure of the src tree can download it,
or browse the README online. Have hier(7) just point them there instead.

PR:		261349
Discussed with:	freebsd-arch@, freebsd-doc@ lists
Reviewed by:	imp, emaste
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37135
 2022-11-01 12:20:55 -03:00
Mitchell Horne
9e0dcd0ab2 README.md: shift description of kernel config files 
Document it in sys/README.md instead. Describe the purpose of LINT
config files as well.

Reviewed by:	imp
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37134
 2022-11-01 12:20:55 -03:00
Mitchell Horne
d1087fe843 Create sys/README.md 
Add this primarily to document the sys/ subdirectories of the source tree.

This is a straight copy from the contents of hier(7). Improvements will
follow in other changes.

Reviewed by:	imp, emaste
MFC after:	1 month
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D37132
 2022-11-01 12:20:55 -03:00
Ed Maste
266cbbfc65 README.md: update gnu directory description 
(At this point in main we have just LGPL libdialog and dialog, and GPL
diff3, left in gnu/.)

Reported by:	bapt
MFC after:	3 days
Sponsored by:	The FreeBSD Foundation
 2021-12-17 08:45:31 -05:00
Fabian Keil
8b9fe05a49 README.md: correct GPL expansion 
PR:		260404
MFC after:	3 days
 2021-12-14 16:51:22 -05:00
Li-Wen Hsu
aaf998056e
Whitespace cleanup 2021-03-12 19:57:58 +08:00
Li-Wen Hsu
cada2b74b8
Update doc links in README 2021-03-12 19:57:58 +08:00
Warner Losh
e75eac2cb8 readme: Link to COPYRIGHT file 2021-03-11 17:55:16 -07:00
Warner Losh
dbd92cc2a4 Fix arch rendering 2021-03-11 17:52:13 -07:00
Warner Losh
2918e9fdb8 readme: update style 
Update the style to one sentence per line, as is currently used in the FreeBSD
document project. Make the links to the handbook clickable.
 2021-03-11 17:38:30 -07:00
Li-Wen Hsu
5ef5f51d2b
Mark the repository has been converted to Git 
This is the first Git commit to src.

Sponsored by:	The FreeBSD Foundation
 2020-12-23 12:27:27 +08:00
Li-Wen Hsu
3cc0c0d66a Mark the repository as being converted to Git. 
This is the last Subversion commit to src.

Sponsored by:	The FreeBSD Foundation
 2020-12-20 02:59:44 +00:00
Eitan Adler
0eba55c34b 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
Eitan Adler
7c0631790c 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
Edward Tomasz Napierala
5924726086 Fix README.md formatting. 
MFC after:	2 weeks
Sponsored by:	DARPA, AFRL
 2018-03-02 14:42:08 +00:00
Mark Johnston
8960a01967 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
Eitan Adler
745ddc1000 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
Eitan Adler
a2aef24aa3 Update several more URLs 
- Primarily http -> https
- Primarily FreeBSD project URLs
 2017-10-29 08:17:03 +00:00
Ed Maste
ee9ffb4ff9 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
Warner Losh
26e8791990 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