d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
30700bc80e
freebsd-nq/README

82 lines
2.4 KiB
Plaintext
Raw Normal View History

Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
This is the top level of the FreeBSD source directory. This file
$Id$ -> $FreeBSD$
1999-08-28 01:35:59 +00:00
was last revised on:
$FreeBSD$
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
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
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.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
For copyright information, please see the file COPYRIGHT in this
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
directory. Additional copyright information also exists for some
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
sources in this tree - please see the specific source directories for
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
more information.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
The Makefile in this directory supports a number of targets for
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
building components (or all) of the FreeBSD source tree. See build(7), config(8),
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
Simply running ``make world'' will bomb unless you dig up the undocumented HISTORICAL_MAKE_WORLD variable and set it. Note it here so the blow up will not really be a surprise to people who read. Link the buildingworld chapter of our handbook in the README while I'm here.
2006-06-07 03:33:48 +00:00
for more information, including setting make(1) variables.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
Source Roadmap:
---------------
README: changes and fixups Two orthogonal goals: - try to make README look a little nicer on phabricator by using Remarkup syntax for commands (using `` instead of using a closing ') - try to make README look a little nicer on github. - Don't encourage `make world` when the handbook specifies otherwise - Change language around documentation to be a bit clearer MFC After: 2 weeks
2015-04-19 07:16:44 +00:00
Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5.
2002-03-26 12:35:49 +00:00
bin System/user commands.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
Add the cddl/ directory.
2010-11-14 11:32:56 +00:00
cddl Various commands and libraries under the Common Development
and Distribution License.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
contrib Packages contributed by 3rd parties.
Reflect reality: - Make world doesn't build the modules any more. - Mention the buildkernel/installkernel targets as common used targets. - LINT has gone, NOTES is new but cannot be built. It is a pure reference file. However, I still mentioned LINT but pointed out the difference between the ancient LINT and the new NOTES. This should avoid confusion. - crypto/ subdir isn't export controlled any more.
2000-07-31 09:22:50 +00:00
crypto Cryptography stuff (see crypto/README).
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5.
2002-03-26 12:35:49 +00:00
etc Template files for /etc.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
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 (cherry picked from commit 266cbbfc65263a3b8bc7c95dd3d589aab7cefe7f)
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* for more information.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
include System include files.
Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5.
2002-03-26 12:35:49 +00:00
kerberos5 Kerberos5 (Heimdal) package.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
lib System libraries.
libexec System daemons.
release Release building Makefile & associated tools.
Add a note explaining what the rescue/ directory is for. PR: docs/93990 Submitted by: Ulf Lilleengen MFC after: 3 days
2006-03-01 20:14:55 +00:00
rescue Build system for statically linked /rescue utilities.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
sbin System commands.
Slightly improve the description of "crypto". "DES" is a subset of what we have in secure/.
2000-08-31 17:59:01 +00:00
secure Cryptographic libraries and commands.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
share Shared resources.
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
stand Boot loader sources.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
sys Kernel sources.
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
sys/<arch>/conf Kernel configuration files. GENERIC is the configuration
used in release builds. NOTES contains documentation of
all possible entries.
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
README: - the reference to 'ancient' LINT file was added in 2000 [r64047 | alex | 2000-07-31]. Remove the reference entirely now. - add the tests directory
2015-04-12 23:43:41 +00:00
tests Regression tests which can be run by Kyua. See tests/README
for additional information.
Bring back the README, this time attempting to be a little more informative about what the user is seeing here.
1997-01-01 14:06:29 +00:00
tools Utilities for regression testing and miscellaneous tasks.
usr.bin User commands.
usr.sbin System administration commands.
For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:
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
https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
Reference in New Issue Copy Permalink