Skip to content

Commit bb438e0

Browse files
docs(readme): 📝 update summary and add contributing links
1 parent 9915b95 commit bb438e0

2 files changed

Lines changed: 91 additions & 4 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- build(make): 🔧 practicalli tasks for zensical
1111
- build(zensical): 💄 overrides updated for zensical
1212
- build(zensical): 💄 add automatic palette for light or dark
13+
- docs(readme): 📝 update summary and add contributing links
1314

1415
## 2023-03-10
1516
### Added

‎README.md‎

Lines changed: 90 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
## ARCHIVED
1+
# Practicalli ClojureScript
22

3-
Retired content.
3+
```none
4+
██████╗ ██████╗ █████╗ ██████╗████████╗██╗ ██████╗ █████╗ ██╗ ██╗ ██╗
5+
██╔══██╗██╔══██╗██╔══██╗██╔════╝╚══██╔══╝██║██╔════╝██╔══██╗██║ ██║ ██║
6+
██████╔╝██████╔╝███████║██║ ██║ ██║██║ ███████║██║ ██║ ██║
7+
██╔═══╝ ██╔══██╗██╔══██║██║ ██║ ██║██║ ██╔══██║██║ ██║ ██║
8+
██║ ██║ ██║██║ ██║╚██████╗ ██║ ██║╚██████╗██║ ██║███████╗███████╗██║
9+
╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚═╝
410
511
6-
## Summary
12+
> NOTE: Ascii Art Generator: https://patorjk.com/software/taag/#p=display&f=ANSI%20Shadow&t=Practicalli%205
13+
14+
## Book Overview
15+
16+
A guide to software development with the ClojureScript programming language, using Clojure CLI and a wide range of community tools for a REPL focused workflow.
17+
18+
The guide uses Practicalli Clojure CLI Config to provide aliases to run over 30 community tools that complement the workflow, including a REPL Reloaded workflow for a highly interactive and effective development experience.
719
820
Learn how to develop simple client-side web applications using the ClojureScript programming language, a functional programming language compiled to JavaScript.
921
@@ -13,7 +25,8 @@ Figwheel-main is a build tool which provides a highly interactive development wo
1325
1426
Reagent, a react-style library, is used for single page applications. Hiccup and Selma are used for managing content.
1527
16-
Clojure CLI provides an array of tools to support development, using project and user `deps.edn` configuration files.
28+
29+
Learning ClojureScript syntax and how to think in a functional design is also covered with code examples and challenge that help embed these concepts.
1730
1831
1932
## Creative commons license
@@ -23,6 +36,20 @@ Clojure CLI provides an array of tools to support development, using project and
2336
This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License (including images & stylesheets).
2437
</div>
2538
39+
## Contributing
40+
41+
Issues and pull requests are most welcome although it is the maintainers discression as to if they are applicable. Please detail issues as much as you can. Pull requests are simpler to work with when they are specific to a page or at most a section. The smaller the change the quicker it is to review and merge.
42+
43+
Please read the [detailed Practicalli contributing page](https://practical.li/contributing/) before raising an issue or pull request to avoid disappointment.
44+
45+
* [Current Issues](https://github.com/practicalli/clojurescript/issues)
46+
* [Current pull requests](https://github.com/practicalli/clojurescript/pulls)
47+
48+
[Practicalli Clojure CLI Config](clojure/clojure-cli/practicalli-config.md) provides a user level configuration providing aliases for community tools used throughout this guide. Issues and pull requests can also be made via its GitHub repository.
49+
50+
By submitting content ideas and corrections you are agreeing they can be used in this workshop under the [Creative Commons Attribution ShareAlike 4.0 International license](https://creativecommons.org/licenses/by-sa/4.0/). Attribution will be detailed via [GitHub contributors](https://github.com/practicalli/engineering-playbook/graphs/contributors).
51+
52+
2653
## Sponsor Practicalli
2754
2855
[![Sponsor Practicalli via GitHub](https://raw.githubusercontent.com/practicalli/graphic-design/live/buttons/practicalli-github-sponsors-button.png)](https://github.com/sponsors/practicalli-johnny/)
@@ -37,3 +64,62 @@ Thanks to [Cognitect](https://www.cognitect.com/), [Nubank](https://nubank.com.b
3764
[![Star History Chart](https://api.star-history.com/svg?repos=practicalli/clojurescript&type=Date)](https://star-history.com/#practicalli/clojurescript&Date)
3865
3966
67+
## GitHub Actions
68+
69+
The megalinter GitHub actions will run when a pull request is created,checking basic markdown syntax.
70+
71+
A review of the change will be carried out by the Practicalli team and the PR merged if the change is acceptable.
72+
73+
The Publish Book GitHub action will run when PR's are merged into main (or the Practicalli team pushes changes to the default branch).
74+
75+
Publish book workflow installs Material for MkDocs version 9
76+
77+
78+
## Local development
79+
80+
Zensical can be installed locally via vu or pip. Practicalli uses uv and installs Zensical as a tool for simplicity.
81+
82+
CLI Commands are wrapped in tasks defined within the `Makefile`, providing a simpler and consistent user experience.
83+
84+
[Zensical - Practcialli Engineering Playbook](https://practical.li/engineering-playbook/technical-writing/static-site/zensical/)
85+
86+
Clone the repository and change into the root of the project.
87+
88+
```shell
89+
git clone https://github.com/practicalli/clojurescript
90+
```
91+
92+
Install Zensical as a tool using `uv` (updating if there is a new version).
93+
94+
```shell
95+
make docs-install
96+
```
97+
98+
Or use the uv command:
99+
100+
```shell
101+
uv tool install zensical --with catppuccin-zensical --upgrade
102+
```
103+
104+
105+
Build the website and serve locally at [http://localhost:8000](http://localhost:8000)
106+
107+
```shell
108+
make docs
109+
```
110+
111+
Or use the zensical command:
112+
113+
```shell
114+
zensical serve --dev-addr localhost:7777
115+
```
116+
117+
---
118+
119+
Specific command if now using make:
120+
121+
Create a virtual python in the root of the project.
122+
123+
```shell
124+
uv tool install zensical --upgrade
125+
```

0 commit comments

Comments
 (0)