jimzah/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src.git synced 2024-11-26 22:23:08 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
main
freebsd-src/README.md

48 lines
2.9 KiB
Markdown
Raw Permalink Normal View History

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
FreeBSD Source:
---------------
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-12 00:21:16 +00:00
This is the top level of the FreeBSD source directory.
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
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-12 00:21:16 +00:00
FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms.
A large community has continually developed it for more than thirty years.
Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.
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 05:09:01 +01:00
readme: Link to COPYRIGHT file
2021-03-12 00:55:16 +00:00
For copyright information, please see [the file COPYRIGHT](COPYRIGHT) in this directory.
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-12 00:21:16 +00:00
Additional copyright information also exists for some sources in this tree - please see the specific source directories for more information.
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
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-12 00:21:16 +00:00
The Makefile in this directory supports a number of targets for building components (or all) of the FreeBSD source tree.
Update doc links in README
2021-03-12 11:55:56 +00:00
See build(7), config(8), [FreeBSD handbook on building userland](https://docs.freebsd.org/en/books/handbook/cutting-edge/#makeworld), and [Handbook for kernels](https://docs.freebsd.org/en/books/handbook/kernelconfig/) for more information, including setting make(1) variables.
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
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 15:20:01 +00:00
For information on the CPU architectures and platforms supported by FreeBSD, see the [FreeBSD
website's Platforms page](https://www.freebsd.org/platforms/).
Update README.md to add pointer to release page. Reviewed by: imp Pull Request: https://github.com/freebsd/freebsd-src/pull/1151
2024-05-10 03:36:19 +01:00
For official FreeBSD bootable images, see the [release page](https://download.freebsd.org/ftp/releases/ISO-IMAGES/).
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
Source Roadmap:
---------------
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-12 00:21:16 +00:00
| Directory | Description |
Whitespace cleanup
2021-03-12 11:57:30 +00:00
| --------- | ----------- |
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-12 00:21:16 +00:00
| bin | System/user commands. |
| cddl | Various commands and libraries under the Common Development and Distribution License. |
| contrib | Packages contributed by 3rd parties. |
| crypto | Cryptography stuff (see [crypto/README](crypto/README)). |
| etc | Template files for /etc. |
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 13:43:47 +00:00
| gnu | Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](gnu/COPYING.LIB) for more information. |
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-12 00:21:16 +00:00
| include | System include files. |
| kerberos5 | Kerberos5 (Heimdal) package. |
| lib | System libraries. |
| libexec | System daemons. |
| release | Release building Makefile & associated tools. |
| rescue | Build system for statically linked /rescue utilities. |
| sbin | System commands. |
| secure | Cryptographic libraries and commands. |
| share | Shared resources. |
| stand | Boot loader sources. |
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 15:12:14 +00:00
| sys | Kernel sources (see [sys/README.md](sys/README.md)). |
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 15:15:18 +00:00
| targets | Support for experimental `DIRDEPS_BUILD` |
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-12 00:21:16 +00:00
| tests | Regression tests which can be run by Kyua. See [tests/README](tests/README) for additional information. |
| tools | Utilities for regression testing and miscellaneous tasks. |
| usr.bin | User commands. |
| usr.sbin | System administration commands. |
Update doc links in README
2021-03-12 11:55:56 +00:00
For information on synchronizing your source tree with one or more of the FreeBSD Project's development branches, please see [FreeBSD Handbook](https://docs.freebsd.org/en/books/handbook/cutting-edge/#current-stable).
Reference in New Issue Copy Permalink