scalar: start documenting the command
Let's build up the documentation for the Scalar command along with the patches that implement its functionality. Note: To discourage the feature-incomplete documentation from being mistaken for the complete thing, we do not yet provide any way to build HTML or manual pages from the text file. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Johannes Schindelin committed
Dec 3, 2021 at 13:34 UTC
829fe56c62a7a42d32fe591919ac0ca96fddc486
1 file changed
+38
contrib/scalar/scalar.txt
new
+38
@@ -0,0 +1,38 @@
1
+scalar(1)
2
+=========
3
+
4
+NAME
5
+----
6
+scalar - an opinionated repository management tool
7
+
8
+SYNOPSIS
9
+--------
10
+[verse]
11
+scalar <command> [<options>]
12
+
13
+DESCRIPTION
14
+-----------
15
+
16
+Scalar is an opinionated repository management tool. By creating new
17
+repositories or registering existing repositories with Scalar, your Git
18
+experience will speed up. Scalar sets advanced Git config settings,
19
+maintains your repositories in the background, and helps reduce data sent
20
+across the network.
21
+
22
+An important Scalar concept is the enlistment: this is the top-level directory
23
+of the project. It usually contains the subdirectory `src/` which is a Git
24
+worktree. This encourages the separation between tracked files (inside `src/`)
25
+and untracked files, such as build artifacts (outside `src/`). When registering
26
+an existing Git worktree with Scalar whose name is not `src`, the enlistment
27
+will be identical to the worktree.
28
+
29
+The `scalar` command implements various subcommands, and different options
30
+depending on the subcommand.
31
+
32
+SEE ALSO
33
+--------
34
+linkgit:git-maintenance[1].
35
+
36
+Scalar
37
+---
38
+Associated with the linkgit:git[1] suite