Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ramblurr committed May 27, 2024
1 parent d3a5de5 commit edf5e5f
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

[![License][license]][license-url]

This project is powered by Clerk.
This is a ClojureScript implementation of the samples and exercises from [Nature of Code (2nd Edition)](noc2) by Daniel Shiffman

> ➡️View live at: https://ramblurr.github.io/nature-of-code/
## Dependencies

`clj`, `shadow-cljs`, `node` and

- [Clojure CLI tools](https://clojure.org/guides/install_clojure)
- [`babashka`](https://github.com/babashka/babashka#installation)

To publish to GitHub Pages, you'll also need `node` installed, preferably via
[`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating).
- [`nvm`](https://github.com/nvm-sh/nvm#installing-and-updating).

## Developing with Clerk

Expand All @@ -34,7 +34,7 @@ clj
Then start the server:

```clj
(start!)
(start-with-shadow!)
```

To show a file, pass it to `clerk/show!`:
Expand All @@ -58,25 +58,12 @@ bb build-static

To generate a static site locally.

### Push to GitHub

Create a repo at https://github.com/new.

### Garden

The easiest way to share a static build is to push to GitHub, then visit

https://github.clerk.garden/ramblurr/nature-of-code


### GitHub Pages

To release to GitHub Pages, run

```
bb release-gh-pages
```

## Linting

Run
Expand Down Expand Up @@ -112,3 +99,4 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.

[license]: https://img.shields.io/github/license/ramblurr/nature-of-code
[license-url]: LICENSE
[noc2]: https://github.com/nature-of-code/noc-book-2

0 comments on commit edf5e5f

Please sign in to comment.