Commit 567f4bb18c7164b6d4c8c0c8cfeb19b3409675b4
2020-03-28T11:56:33
Add quickstart section, document install-repo.sh
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
diff --git a/README.md b/README.md
index 748d64b..0b31ea0 100644
--- a/README.md
+++ b/README.md
@@ -8,68 +8,76 @@ packages and keep them synced with upstream for development purposes.
Each repo is installed in a subdirectory.
Github repositories are installed in the user subdirectory.
-## Usage
+## Quickstart
+
+``` SH
+curl -O https://github.com/common-lisp-repo/repo/blob/master/install-repo.sh
+sh install-repo.sh
+```
+
+## Installation
+
+This is what the `install-repo.sh` script does :
Install ASDF from git :
``` SH
-mkdir -p ~/common-lisp/fare
-cd ~/common-lisp/fare
-git clone https://github.com/fare/asdf.git
-cd asdf
-make
+ mkdir -p ~/common-lisp/fare
+ cd ~/common-lisp/fare
+ git clone https://github.com/fare/asdf.git
+ cd asdf
+ make
```
Install REPO from git :
``` SH
-mkdir -p ~/common-lisp/common-lisp-repo
-cd ~/common-lisp/common-lisp-repo
-git clone https://github.com/common-lisp-repo/repo.git
-make
+ mkdir -p ~/common-lisp/common-lisp-repo
+ cd ~/common-lisp/common-lisp-repo
+ git clone https://github.com/common-lisp-repo/repo.git
```
In your Common Lisp implementation startup file :
``` Common-Lisp
-(load "~/common-lisp/fare/asdf/build/asdf")
-(load "~/common-lisp/common-lisp-repo/repo/repo")
-(repo:boot)
+ (load "~/common-lisp/fare/asdf/build/asdf")
+ (load "~/common-lisp/common-lisp-repo/repo/repo")
+ (repo:boot)
```
Repo integrates with ASDF :
``` Common-Lisp
-(asdf:load-system :thot)
+ (asdf:load-system :thot)
```
To update all repositories :
``` Common-Lisp
-(repo:update repo:*manifest*)
+ (repo:update repo:*manifest*)
```
Other functions :
``` Common-Lisp
-(repo:repo "github:thodg/repo") ;; Define repository by URI
+ (repo:repo "github:thodg/repo") ;; Define repository by URI
-(repo:repo "thodg/repo") ;; Find repository by dir/name
-(repo:repo :repo) ;; Find repository by name
+ (repo:repo "thodg/repo") ;; Find repository by dir/name
+ (repo:repo :repo) ;; Find repository by name
-(setf repo:*repo-dir* "/tmp/repo-test") ;; Change installation directory
+ (setf repo:*repo-dir* "/tmp/repo-test") ;; Change installation directory
-(repo:install "github:thodg/repo") ;; Install repository by URI
-(repo:install "thodg/repo") ;; Install repository by dir/name
-(repo:install :repo) ;; Install repository by name
+ (repo:install "github:thodg/repo") ;; Install repository by URI
+ (repo:install "thodg/repo") ;; Install repository by dir/name
+ (repo:install :repo) ;; Install repository by name
-(repo:update "github:thodg/repo") ;; Update repository by URI
-(repo:update "thodg/repo") ;; Update repository by dir/name
-(repo:update :repo) ;; Update repository by name
+ (repo:update "github:thodg/repo") ;; Update repository by URI
+ (repo:update "thodg/repo") ;; Update repository by dir/name
+ (repo:update :repo) ;; Update repository by name
-repo:*repos* ;; List of defined repositories
+ repo:*repos* ;; List of defined repositories
-(repo:clear-repos) ;; Clear all definitions
+ (repo:clear-repos) ;; Clear all definitions
```
## Version informations