Skip to content

Commit

Permalink
Usage by example. #1
Browse files Browse the repository at this point in the history
  • Loading branch information
eigenhombre committed Nov 21, 2022
1 parent 954a86d commit 13c07b2
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 8 deletions.
42 changes: 35 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,44 @@ that directory. Then,
# Optionally:
make install # Assumes BINDIR defined; I use ~/bin

# Usage
# Example of Usage

Assuming you want to build a project `myproject`,

steelcut myproject # Prepend ./ if you didn't `make install`.
cd $LISP_HOME/myproject
make
# Optionally:
make install
myproject # Prepend ./ if you didn't `make install`.
$ steelcut
Usage: steelcut <appname>
$ steelcut myproject
Project myproject created. Thanks for using steelcut!
$ cd $LISP_HOME/myproject
$ make
./build.sh
This is SBCL 2.2.6, an implementation of ANSI Common Lisp.
More information about SBCL is available at <http:https://www.sbcl.org/>.

SBCL is free software, provided as is, with absolutely no warranty.
It is mostly in the public domain; some portions are provided under
BSD-style licenses. See the CREDITS and COPYING files in the
distribution for more information.
To load "myproject":
Load 1 ASDF system:
myproject
; Loading "myproject"
[package myproject]
[undoing binding stack and other enclosing state... done]
[performing final GC... done]
[saving current Lisp image into myproject:
writing 1840 bytes from the read-only space at 0x300000000
writing 1840 bytes from the static space at 0x300200000
writing 0 bytes from the immobile space at 0x300300000
writing 42270720 bytes from the dynamic space at 0x7003000000
done]
$ make install
test -n "/Users/jacobsen/bin" # $BINDIR
cp myproject /Users/jacobsen/bin
$ cd
$ myproject
Thanks for using myproject!
$

# License

Expand Down
2 changes: 1 addition & 1 deletion src/main.lisp
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ sbcl --non-interactive \\
(project-contents "foo"))

(defun usage ()
"Usage: PROJNAME <appname>")
"Usage: steelcut <appname>")

(defun main ()
(let* ((args sb-ext::*posix-argv*)
Expand Down

0 comments on commit 13c07b2

Please sign in to comment.