Commit Graph

33 Commits

Author SHA1 Message Date
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
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
gjb
5553349daf Correct the URL to instructions for updated system sources.
MFC after:	3 days
Submitted by:	schaiba <at> gmail <dot> com
PR:		219303
Sponsored by:	The FreeBSD Foundation
2017-05-15 15:18:36 +00:00
avos
6147552d9a README: remove nonexistent 'games' directory.
Games were moved to usr.bin in r288485.

(todo: add/describe 'targets' directory)
2016-05-18 10:43:13 +00:00
eadler
a33347cf10 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
eadler
e3b60002c6 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
joel
a25e937c7a Add the cddl/ directory. 2010-11-14 11:32:56 +00:00
trhodes
20e391b445 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
ceri
15a5b0ca2d 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
markm
e41e907c30 KerberosIV de-orbit burn continues. Disconnect from "make world". 2003-03-08 10:01:26 +00:00
wosch
b9937742c3 Fix broken handbook links.
Submitted by:	"Dipl.Phys. Andreas Hiltenkamp" <hiltenkamp@web.de>
2002-07-21 16:45:30 +00:00
ru
6970613f93 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
markm
f5f42b593b Slightly improve the description of "crypto". "DES" is a subset of
what we have in secure/.
2000-08-31 17:59:01 +00:00
alex
9dfcf4d5a8 secure/ may be exported now. 2000-08-13 14:34:35 +00:00
alex
a540cd2f79 Point out, that build/installkernel need a built world and that more
information can be found in the handbook.

Requested by:	sheldonh
Reviewed by:	sheldonh
2000-07-31 12:39:09 +00:00
alex
753cf540b9 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
peter
efabb9ccb1 $Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00
peter
12189ca801 No more src/lkm dir... 1999-01-06 14:02:35 +00:00
markm
84e77be3da Correct the facts. The kerberosIV/ directory is not export restricted. 1998-09-13 09:38:34 +00:00
jkh
ad22b67422 Re-alphabetize and update the subdir descriptions.
PR:		7116
1998-06-30 08:08:05 +00:00
jkh
fc739b7159 Note that /etc is not installed by world target either. 1997-08-09 14:36:20 +00:00
peter
f173325ac8 Revert $FreeBSD$ to $Id$ 1997-02-23 09:21:14 +00:00
jkh
808a36ef65 Make the long-awaited change from $Id$ to $FreeBSD$
This will make a number of things easier in the future, as well as (finally!)
avoiding the Id-smashing problem which has plagued developers for so long.

Boy, I'm glad we're not using sup anymore.  This update would have been
insane otherwise.
1997-01-14 07:20:47 +00:00
max
f25134f888 Typo (maybe), config(1) -> config(8). 1997-01-06 08:04:25 +00:00
jkh
01876569b2 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
peter
ab124e78b0 recording cvs-1.6 file death 1995-12-30 19:02:48 +00:00
jkh
987f5007c2 Small tweak - I said that ESC-ESC aborted the install. It actually only
suspends it.  Whoops!
1994-11-10 04:28:15 +00:00
jkh
59a6c2c501 Here's the README for the ALPHA. It's less verbose, having had much
moved into its more proper home in the release notes.
1994-11-08 03:26:37 +00:00
jkh
401370279e Add a little bit of documentation about how to use dialog boxes
and such.
1994-11-07 10:39:14 +00:00
jkh
602290db99 Make note of the fact that debugging information is printed to screen 2. 1994-11-02 07:02:13 +00:00
phk
734e80df5a Put the README where we need it. This comes from the ...INPUT file. 1994-10-26 04:28:10 +00:00