Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review / Update docs #439

Merged
merged 6 commits into from
Aug 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ To run the build "manually" execute the following from the root directory of the
[asdf-registry-config]: https://common-lisp.net/project/asdf/asdf/Configuring-ASDF-to-find-your-systems.html
[asdf]: https://common-lisp.net/project/asdf/
[common-lisp-analyzer]: https://github.com/exercism/common-lisp-analyzer
[common-lisp-representer]: https://github.com/exercism/common-lisp-representer.
[common-lisp-representer]: https://github.com/exercism/common-lisp-representer
[common-lisp-test-runner]: https://github.com/exercism/common-lisp-test-runner
[common-lisp]: https://common-lisp.net
[concept-exercise]: https://github.com/exercism/docs/blob/main/building/tracks/concept-exercises.md
Expand Down
4 changes: 3 additions & 1 deletion docs/ABOUT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ It's a multi-paradigm programming language that allows you to choose the approac
Common Lisp has fast prototyping capabilities, and exceptional support for object oriented programming.
It also boasts a macro system which allows you to adapt the language to your needs, and a run-time environment which allows modification of running applications.

To learn more about Common Lisp, take a look at [the Common Lisp homepage](https://common-lisp.net/).
To learn more about Common Lisp, take a look at [the Common Lisp homepage][common-lisp-net]

[common-lisp-net]: https://common-lisp.net/
3 changes: 1 addition & 2 deletions docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,12 @@ Everything comes already configured out of the box. Install Portacle by download

Note: Emacs (text editor) can be disorienting at first, if you're not accustomed to it. Fortunately there are many primers on Emacs and SLIME available online.


## Traditional Start

If you prefer installing the needed tools separately you will need to install and set up:

- a Lisp-aware text editor: [Emacs][emacs] with the [Slime][slime] or [Sly][sly] package is a common choice but [VIM][vim] with [SLIMV][slimv], [Atom][atom] with [SLIMA][slima] or [VSCode][vscode] with a [Common Lisp plugin][vscode-plugin] are also good.
- a Common Lisp implementation: [SBCL][sbcl] is a "safe" choice which works across Linux, MacOS and Windows. Since the language is based upon a standard other (conforming implementations)[awesome-cl-implementations] will work as well.
- a Common Lisp implementation: [SBCL][sbcl] is a "safe" choice which works across Linux, MacOS and Windows. Since the language is based upon a standard other [conforming implementations][awesome-cl-implementations] will work as well.
- [Quicklisp][quicklisp] for library management. After downloading it, follow the [instructions][quicklisp-install] to ensure it is properly integrated with your Common Lisp implementation.

[atom]: https://atom.io
Expand Down
3 changes: 2 additions & 1 deletion docs/LEARNING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ These resources can help you get started:
by various contributors
* [Awesome Common Lisp Learning][awesome-cl]

See also, within this Exercism Common Lisp track: [Important Resources](http://exercism.io/languages/common-lisp/resources)
See also, within this Exercism Common Lisp track: [Important Resources][track-resources].

[awesome-cl]: https://github.com/GustavBertram/awesome-common-lisp-learning
[cl-cookbook]: https://lispcookbook.github.io/cl-cookbook/
[cliki-getting-started]: http://cliki.net/Getting%20Started
[practical-cl]: http://www.gigamonkeys.com/book/
[road-to-cl]: http://stevelosh.com/blog/2018/08/a-road-to-common-lisp/
[track-resources]: /docs/tracks/common-lisp
[wikibooks-cl-first-steps]: http://en.wikibooks.org/wiki/Common_Lisp/First_steps
3 changes: 2 additions & 1 deletion docs/RESOURCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ Quick-guides / cheat sheets for Common Lisp:
[cl-cookbook]: http://lispcookbook.github.io/cl-cookbook/
[cl-quickref]: http://clqr.boundp.org/
[cliki]: http://www.cliki.net/
[common-lisp-gentle-introduction]: http://www-cgi.cs.cmu.edu/afs/cs.cmu.edu/user/dst/www/LispBook/index.html
[common-lisp-gentle-introduction]:
https://www.cs.cmu.edu/~dst/LispBook/
[common-lisp-interactive]: http://www.cse.buffalo.edu/~shapiro/Commonlisp/
[common-lisp-net]: http://common-lisp.net/
[hyperspec]: http://www.lispworks.com/documentation/common-lisp.html
Expand Down
9 changes: 0 additions & 9 deletions docs/template-production.lisp

This file was deleted.

17 changes: 0 additions & 17 deletions docs/template-test.lisp

This file was deleted.

4 changes: 3 additions & 1 deletion exercises/shared/.docs/debug.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Debug

To help with debugging, you can use [`print` or similar functions](http://www.lispworks.com/documentation/HyperSpec/Body/f_wr_pr.htm) to write to standard output which will be visible in the test output.
To help with debugging, you can use [`print` or similar functions][cl-print] to write to standard output which will be visible in the test output.

For example adding `(print "hello there")` into the function you are writing will cause it to be visible in the test runs (given that the test executes that function).

One "trick": if you have several things to print out is to collect them together in a list and then print that: `(print (list :this "that" 'the-other))`.

[cl-print]: http://www.lispworks.com/documentation/HyperSpec/Body/f_wr_pr.htm

16 changes: 11 additions & 5 deletions exercises/shared/.docs/help.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
## Setup

Check out [Installing Common
Lisp](https://exercism.lol/docs/tracks/common-lisp/installation) for
Lisp][track-install] for
instructions to get started or take a look at the guides available in
the [track's documentation pages](https://exercism.lol/docs/tracks/common-lisp).
the [track's documentation pages][track-docs].

## Where to look for help

Any of the resources listed in the list of [Useful Common Lisp Resources](https://exercism.lol/docs/tracks/common-lisp/resources) are good places to look for information.
Any of the resources listed in the list of [Useful Common Lisp Resources][track-resources] are good places to look for information.

There are also some [Online Communities](https://github.com/GustavBertram/awesome-common-lisp-learning#online-community) which may be good places to go for help.
There are also some [Online Communities][awesome-cl-communities] which may be good places to go for help.

## Formatting

Expand Down Expand Up @@ -48,8 +48,14 @@ This can be placed in your `~/.emacs` (or `~/.emacs.d/init.el`) in
order to have it set whenever Emacs is launched.

One suggested add-on for Emacs and Common Lisp is
[SLIME](https://github.com/slime/slime) which offers tight integration
[SLIME][slime] which offers tight integration
with the REPL; making iterative coding and testing very easy.

## Submitting Incomplete Solutions
It's possible to submit an incomplete solution so you can see how others have completed the exercise.

[awesome-cl-communities]: https://github.com/GustavBertram/awesome-common-lisp-learning#online-community
[slime]: https://github.com/slime/slime
[track-docs]: /docs/tracks/common-lisp
[track-install]: /docs/tracks/common-lisp/installation
[track-resources]: /docs/tracks/common-lisp/resources
12 changes: 2 additions & 10 deletions reference/implementing-a-concept-exercise.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,7 @@ placeholders are used:

Before implementing the exercise, please make sure you have a good
understanding of what the exercise should be teaching (and what not).
This information can be found in the exercise's GitHub issue. Having
done this, please read the [Common Lisp concept exercises
introduction][concept-exercises].
This information can be found in the exercise's GitHub issue.

To implement a concept exercise, the following files must be added:

Expand All @@ -50,10 +48,6 @@ languages
└── <SLUG>-test.lisp
</pre>

**IMPORTANT NOTE:** To create these files, you should use the
`generate-scaffolding` tool in the `bin/` directory. See [this
document][scaffolder] to get started.

## Step 1: Add code files

The code files are track-specific and should be designed to help the student learn the exercise's concepts. The following Common Lisp code files must be added (not necessarily in this order):
Expand Down Expand Up @@ -103,12 +97,10 @@ post them as comments in the exercise's GitHub issue.

[analyzer]: https://github.com/exercism/common-lisp-analyzer
[representer]: https://github.com/exercism/common-lisp-representer
[concept-exercises]: ../exercises/concept/README.md
[how-to-implement-a-concept-exercise]: https://github.com/exercism/v3/blob/main/docs/maintainers/generic-how-to-implement-a-concept-exercise.md
[docs-concept-exercises]: https://github.com/exercism/v3/blob/main/docs/concept-exercises.md
[docs-rationale-for-v3]: https://github.com/exercism/v3/blob/main/docs/rationale-for-v3.md
[docs-features-of-v3]: https://github.com/exercism/v3/blob/main/docs/features-of-v3.md
[anatomy-of-a-concept-exercise]: https://www.youtube.com/watch?v=gkbBqd7hPrA
[reference]: https://github.com/exercism/v3/blob/main/reference
[socks-and-sexprs]: ../exercises/concept/socks-and-sexprs
[scaffolder]: ../bin/generate-scaffolding/README.md
[socks-and-sexprs]: https://github.com/exercism/common-lisp/exercises/concept/socks-and-sexprs