Skip to content

Commit 73bf6cd

Browse files
committed
Update wording in Project Setup section
1 parent 8ff9252 commit 73bf6cd

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

index.adoc

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,40 +23,41 @@ writing web applications. This documentation will take you through
2323
Duct's setup and operation, using a web application as an example
2424
project.
2525

26-
== Project Setup
26+
== Setup
2727

28-
You'll need to
29-
https://clojure.org/guides/install_clojure[install Clojure] before you
30-
can use Duct. This will add a `clojure` executable to your path.
28+
This section will cover setting up a new Duct project. You'll first need
29+
to ensure that the
30+
https://clojure.org/guides/install_clojure[Clojure CLI is installed].
31+
You can check this by running the `clojure` command.
3132

3233
[,shell]
3334
----
3435
$ clojure --version
3536
Clojure CLI version 1.12.0.1479
3637
----
3738

38-
Next, you'll need to create a project directory. For the purposes of
39-
this example, we'll call the project `tutorial`.
39+
Next, create a project directory. For the purposes of this example,
40+
we'll call the project `tutorial`.
4041

4142
[,shell]
4243
----
4344
$ mkdir tutorial && cd tutorial
4445
----
4546

46-
The Clojure command-line tool looks for a file called `deps.edn`. To use
47-
Duct, we need to add https://github.com/duct-framework/main[Duct Main]
48-
as a dependency, and setup an alias to execute it.
47+
The Clojure CLI looks for a file called `deps.edn`. To use Duct, we need
48+
to add the https://github.com/duct-framework/main[Duct Main] tool as a
49+
dependency, and setup an alias to execute it.
4950

5051
To achieve this, create a new `deps.edn` file with the following
51-
contents:
52+
content:
5253

5354
[,clojure]
5455
----
5556
{:deps {org.duct-framework/main {:mvn/version "0.1.0"}}
5657
:aliases {:duct {:main-opts ["-m" "duct.main"]}}}
5758
----
5859

59-
Duct can now be run by invoking the `duct` alias.
60+
Duct can now be run by invoking the `:duct` alias.
6061

6162
[,shell]
6263
----
@@ -76,16 +77,16 @@ Options:
7677
----
7778

7879
We'll be using this command a lot, so it's highly recommended that you
79-
create an alias for it in your shell. In a POSIX shell such as Bash,
80-
this can be done using the `alias` command.
80+
also create an shell alias. In a POSIX shell such as Bash, this can be
81+
done using the `alias` command.
8182

8283
[,shell]
8384
----
8485
$ alias duct="clojure -M:duct"
8586
----
8687

87-
For the rest of this documentation, we'll assume that this alias has
88-
been defined.
88+
For the rest of this documentation, we'll assume that this shell alias
89+
has been defined.
8990

9091
The final step of the setup process is to create a `duct.edn` file. This
9192
contains the data structure that defines your Duct application. The

0 commit comments

Comments
 (0)