Added Getting Started and Installation instructions in README.md

Author: nandac

.typstignore

@@ -7,11 +7,11 @@
 # - `*` in patterns works, but also matches directory separators: `*.typ` _will_ match `src/x.typ`
 # .git and .typstignore are excluded automatically
 
+.DS_Store
 .github
 scripts
 tests
 Justfile
 # PDF manuals should be included so that they can be linked, but not their sources
 docs/*
 !docs/*.pdf
-.DS_Store

Justfile

@@ -9,8 +9,8 @@ default:
 # generate manual
 doc:
   typst compile docs/manual.typ docs/manual.pdf
-  typst compile docs/thumbnail.typ thumbnail-light.svg
-  typst compile --input theme=dark docs/thumbnail.typ thumbnail-dark.svg
+  # typst compile docs/thumbnail.typ thumbnail-light.svg
+  # typst compile --input theme=dark docs/thumbnail.typ thumbnail-dark.svg
 
 # run test suite
 test *args:

README.md

@@ -11,7 +11,7 @@ Enables CSS colors to be used by their names within a Typst document.
 - [x] Check and/or replace `LICENSE` by something that suits your needs
 - [x] Fill out `typst.toml`
   - See also the [typst/packages README](https://github.com/typst/packages/?tab=readme-ov-file#package-format)
-- [ ] Adapt Repository URLs in `CHANGELOG.md`
+- [x] Adapt Repository URLs in `CHANGELOG.md`
   - Consider only committing that file with your first release, or removing the "Initial Release" part in the beginning
 - [ ] Adapt or deactivate the release workflow in `.github/workflows/release.yml`
   - to deactivate it, delete that file or remove/comment out lines 2-4 (`on:` and following)
@@ -21,8 +21,8 @@ Enables CSS colors to be used by their names within a Typst document.
     - [ ] on this repo, create a secret `REGISTRY_TOKEN` (at `https://github.com/[user]/[repo]/settings/secrets/actions`) that contains the so created token
 
     if configured correctly, whenever you create a tag `v...`, your package will be pushed onto a branch on the `REGISTRY_REPO`, from which you can then create a pull request against [typst/packages](https://github.com/typst/packages/)
-- [ ] remove/replace the example test case
-- [ ] (add your actual code, docs and tests)
+- [x] remove/replace the example test case
+- [x] (add your actual code, docs and tests)
 - [ ] remove this section from the README
 
 ## Getting Started
@@ -32,23 +32,38 @@ These instructions will get you a copy of the project up and running on the typs
 ```typ
 #import "@preview/css-colors:0.1.0": *
 
-#rect(fill: css("darkorchid"))
+Normal text may be #text(fill: css("crimson"))[colored so.]
+
+#rect(width: 100%, height: auto, fill: css("darkorchid"))
 ```
 
 <picture>
   <source media="(prefers-color-scheme: dark)" srcset="./thumbnail-dark.svg">
   <img src="./thumbnail-light.svg">
 </picture>
 
-### Installation
+## Installation
 
-A step by step guide that will tell you how to get the development environment up and running. This should explain how to clone the repo and where to (maybe a link to the typst documentation on it), along with any pre-requisite software and installation steps.
+Set up your development environment by following these steps:
 
-```
-$ First step
-$ Another step
-$ Final step
-```
+1. **Typst**
+   Install Typst (version 0.13.0 or higher) using the [official installation instructions](https://github.com/typst/typst?tab=readme-ov-file#installation).
+
+
+1. **Just**
+   Install [Just](https://just.systems/man/en/introduction.html) using a package manager or by downloading a pre-built binary. For more information, refer to the [available packages](https://just.systems/man/en/packages.html).
+
+1. **tytanic**
+   Install [tytanic](https://tingerrr.github.io/tytanic/index.html) by following the [quickstart installation guide](https://tingerrr.github.io/tytanic/quickstart/install.html).
+
+1. **Clone the Repository**
+   Clone the project repository to your local machine:
+
+    ```bash
+    git clone https://github.com/kleinbottle/css-colors.git
+    ```
+
+Once you've completed these steps, your development environment will be ready.
 
 ## Usage
 

docs/manual.pdf

@@ -110,7 +110,7 @@ You may also view them in a browser by clicking on this #link("https://htmlprevi
 
 The CSS Colors Module provides a function `css` defined as:
 
-```
+```typ
 css(
   str color-name
 ) -> color
@@ -136,52 +136,52 @@ The following examples demonstrate the usage of the `css` function in various ca
 
 + Coloring text.
 
-  ```
-    #import "@preview/css-colors:0.1.0": *
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
 
-    Normal text may be #text(fill: css("crimson"))[colored so.]
-    ```
+  Normal text may be #text(fill: css("crimson"))[colored so.]
+  ```
 
   Normal text may be #text(fill: css("crimson"))[colored so.]
 
 + A rectangle may be colored with `fill`.
 
-  ```
-    #import "@preview/css-colors:0.1.0": *
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
 
-    #rect(width: 100%, height: auto, fill: css("darkorchid"))
-    ```
+  #rect(width: 100%, height: auto, fill: css("darkorchid"))
+  ```
 
   #rect(width: 100%, height: auto, fill: css("darkorchid"))
 
 + CSS colors may be specified in either lowercase or CamelCase.
 
-  ```
-    #import "@preview/css-colors:0.1.0": *
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
 
-    (a) saddlebrown: #box(width: 30mm, height: 1em, fill: css("saddlebrown"))
+  (a) saddlebrown: #box(width: 30mm, height: 1em, fill: css("saddlebrown"))
 
-    (b) SaddleBrown: #box(width: 30mm, height: 1em, fill: css("SaddleBrown"))
-    ```
+  (b) SaddleBrown: #box(width: 30mm, height: 1em, fill: css("SaddleBrown"))
+  ```
 
   (a) saddlebrown: #box(width: 30mm, height: 1em, fill: css("saddlebrown"))
 
   (b) SaddleBrown: #box(width: 30mm, height: 1em, fill: css("SaddleBrown"))
 
 + The maroon color in Typst differs from the Maroon color defined in CSS, as evidenced by their distinct hex codes.  To emphasize this distinction, the CSS `Maroon` is intentionally capitalized with an initial uppercase letter.
 
-  ```
-    #import "@preview/css-colors:0.1.0": *
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
 
-    #grid(
-      columns: 3,
-      rows: 2,
-      row-gutter: 10pt,
-      column-gutter: 10pt,
-      [Typst maroon], [#color.maroon.to-hex()], [#box(width: 30mm, height: 1em, fill: maroon)],
-      [CSS maroon], [#css("Maroon").to-hex()], [#box(width: 30mm, height: 1em, fill: css("Maroon"))]
-    )
-    ```
+  #grid(
+    columns: 3,
+    rows: 2,
+    row-gutter: 10pt,
+    column-gutter: 10pt,
+    [Typst maroon], [#color.maroon.to-hex()], [#box(width: 30mm, height: 1em, fill: maroon)],
+    [CSS maroon], [#css("Maroon").to-hex()], [#box(width: 30mm, height: 1em, fill: css("Maroon"))]
+  )
+  ```
 
   #grid(
     columns: 3,
@@ -194,18 +194,18 @@ The following examples demonstrate the usage of the `css` function in various ca
 
 + CSS colors may also be used in the context of drawing and data visualization.
 
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
+
+  #align(center)[
+    #polygon.regular(
+      fill: css("darkgoldenrod").lighten(60%),
+      stroke: (paint: css("darkgoldenrod"), thickness: 4pt, cap: "round"),
+      size: 80mm,
+      vertices: 6,
+    )
+  ]
   ```
-    #import "@preview/css-colors:0.1.0": *
-
-    #align(center)[
-      #polygon.regular(
-        fill: css("darkgoldenrod").lighten(60%),
-        stroke: (paint: css("darkgoldenrod"), thickness: 4pt, cap: "round"),
-        size: 80mm,
-        vertices: 6,
-      )
-    ]
-    ```
 
   #align(center)[
     #polygon.regular(
@@ -219,19 +219,23 @@ The following examples demonstrate the usage of the `css` function in various ca
 + CSS colors may be used to underline text with a line of default thickness. The
   thickness of the underline may be changed manually if desired.
 
-  ```
-    #import "@preview/css-colors:0.1.0": *
+  ```typ
+  #import "@preview/css-colors:0.1.0": *
 
-    This is #underline(stroke: css("teal"))[important.]
+  This is #underline(stroke: css("teal"))[important.]
 
-    This is #underline(stroke: (paint: css("teal"), thickness: 2pt))[important.]
-    ```
+  This is #underline(stroke: (paint: css("teal"), thickness: 2pt))[important.]
+  ```
 
   This is #underline(stroke: css("teal"))[important.]
 
   This is #underline(stroke: (paint: css("teal"), thickness: 2pt))[important.]
 
-== Appendix
+#bibliography("manual.yml", title: "References", style: "ieee")
+
+#pagebreak()
+
+= Appendix 1
 
 #figure(
   align(center)[
@@ -251,6 +255,10 @@ The following examples demonstrate the usage of the `css` function in various ca
   ], caption: [CSS colors sharing the same hex value],
 ) <css-colors-sharing-hex-value>
 
+#pagebreak()
+
+= Appendix 2
+
 #figure(
   align(center)[
     #table(
@@ -270,6 +278,10 @@ The following examples demonstrate the usage of the `css` function in various ca
   ], caption: [Comparison of Typst and CSS colors],
 ) <comparison-typst-css-colors>
 
+#pagebreak()
+
+= Appendix 3
+
 #figure(align(center)[
     #table(
       inset: 10pt,
@@ -383,4 +395,4 @@ The following examples demonstrate the usage of the `css` function in various ca
   ], caption: [Available CSS colors],
 ) <available-css-colors>
 
-#bibliography("manual.yml", title: "References", style: "ieee")
+#pagebreak()