Skip to content

Commit 570bc28

Browse files
docs: stop recommending add-third-party-script-directory! (#80)
Related to #73
1 parent 837921c commit 570bc28

File tree

1 file changed

+9
-27
lines changed

1 file changed

+9
-27
lines changed

scribblings/quickscript.scrbl

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -446,33 +446,15 @@ or on @hyperlink["http://pasterack.org/"]{PasteRack}, and share the link.
446446
A user can then copy/paste the contents into a new script.
447447
Don't forget to include a permissive license such as MIT/Apache 2.
448448

449-
450-
The @emph{best} way to distribute scripts is by creating a package---the user only has to install
451-
the package.
452-
Assuming your scripts are stored in the @racket["scripts"] subdirectory,
453-
include a file (say @racket["register.rkt"]) at the root directory of
454-
the package containing the following code:
455-
@margin-note{If the file @racket["register.rkt"] is not at the root,
456-
the runtime-path needs to be modified accordingly.}
457-
@codeblock|{
458-
#lang racket/base
459-
(require (for-syntax racket/base
460-
racket/runtime-path
461-
(only-in quickscript/library
462-
add-third-party-script-directory!)))
463-
464-
;; This file is going to be called during setup and will automatically
465-
;; register the scripts subdirectory in quickscript's library.
466-
(begin-for-syntax
467-
(define-runtime-path script-dir "scripts")
468-
(add-third-party-script-directory! script-dir))
469-
}|
470-
471-
You can see an example with
472-
@hyperlink["https://github.com/Metaxal/quickscript-extra"]{quickscript-extra}.
473-
474-
Don't forget to register your package on the
475-
@hyperlink["https://pkgs.racket-lang.org/"]{Racket server}.
449+
@; The @emph{best} way to distribute scripts is by creating a package---the user only has to install
450+
@; the package.
451+
@; ... but the current mechanism is broken, see https://github.com/Metaxal/quickscript/issues/79 ...
452+
@;
453+
@; You can see an example with
454+
@; @hyperlink["https://github.com/Metaxal/quickscript-extra"]{quickscript-extra}.
455+
@;
456+
@; Don't forget to register your package on the
457+
@; @hyperlink["https://pkgs.racket-lang.org/"]{Racket server}.
476458

477459

478460
@section{License}

0 commit comments

Comments
 (0)