aboutsummaryrefslogtreecommitdiff
path: root/README-hacking.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-17 18:44:58 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2020-01-17 18:44:58 +0000
commit5781173d071314104ed2e3651b1222b385b0d798 (patch)
treeda4e6e5104641e40f4b54e8aa1258cb950e09f66 /README-hacking.md
parent0c120cbc1575675f96a99703af28a45d8adda2db (diff)
README-hacking.md: script to list installed programs before configure
Until now, the small one-line script that lists programs was introduced in the checklist after running `./project configure'. But people would mostly miss it because they would wait until the configuration is complete. With this commit, that point has been put above the `./project configure' step. Readers are instructed to open a new terminal and run that script, then go to the next step so they see the directories get filled actively. It will also help them understand what is going on.
Diffstat (limited to 'README-hacking.md')
-rw-r--r--README-hacking.md28
1 files changed, 18 insertions, 10 deletions
diff --git a/README-hacking.md b/README-hacking.md
index 5e202b3..a0a21d2 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -553,6 +553,24 @@ First custom commit
$ git checkout -b master # Create and enter new "master" branch.
```
+ - **Prepare to build project**: The `./project configure` command of the
+ next step will build the different software packages within the
+ "build" directory (that you will specify), nothing else on your system
+ will be touched. But since it takes long, it is useful to see what it
+ is building at every instant (its almost impossible to tell from the
+ torrent of commands that are produced!). So open another terminal on
+ your desktop and navigate to the same directory you just clone
+ above. Then run the following command. Before running the `./project
+ configure` command, this command will just print the date, once every
+ second. But as soon as it starts building software, you'll see names
+ of software come while they are being built, and go once they are
+ installed in the project build directory. See the "Inspecting status"
+ section below for more.
+
+ ```shell
+ $ while true; do echo; date; ls .build/software/build-tmp; sleep 1; done
+ ```
+
- **Test the template**: Before making any changes, it is important to
test it and see if everything works properly with the commands
below. If there is any problem in the `./project configure` or
@@ -572,16 +590,6 @@ First custom commit
# Open 'paper.pdf' and see if everything is ok.
```
- - **Software building status**: While the `./project configure` command of
- the step above is busy building all the different software, you can
- check the status by running the following command in another terminal
- (but same project source directory). See the "Inspecting status"
- section below for more.
-
- ```shell
- $ while true; do echo; date; ls .build/software/build-tmp; sleep 1; done
- ```
-
- **Setup the remote**: You can use any [hosting
facility](https://en.wikipedia.org/wiki/Comparison_of_source_code_hosting_facilities)
that supports Git to keep an online copy of your project's version