docs: dir restructure & development guide

titanom · Mar 4, 2024 · 51496bf · 51496bf
1 parent 0d3f136
commit 51496bf
Show file tree

Hide file tree

Showing 16 changed files with 25 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -12,3 +12,27 @@ Install dependencies:
 ```sh
 pnpm i
 ```
+
+## Architecture
+
+This repository is a _monorepo_ powered by [pnpm workspaces](https://pnpm.io/workspaces) & [Turborepo](https://turbo.build/repo/docs).
+
+You can find the different _projects_ in the directories:
+
+- [./examples](./examples)
+  - [./examples/standalone](./examples/standalone) contains an example for using `css2tailwind` in a single repository
+- [./css2tailwind](./css2tailwind) contains the source code for the `css2tailwind` tool
+
+## Developing
+
+After making changes in [./css2tailwind](./css2tailwind), you must build the CLI.
+
+```sh
+pnpm -F @titanom/css2tailwind build
+```
+
+Then you can use it with any of the examples, e.g. with `standalone`.
+
+```sh
+pnpm -F @css2tw/standalone dev
+```
diff --git a/packages/css2tailwind/.npmignore → css2tailwind/.npmignore b/packages/css2tailwind/.npmignore → css2tailwind/.npmignore
diff --git a/packages/css2tailwind/.prettierignore → css2tailwind/.prettierignore b/packages/css2tailwind/.prettierignore → css2tailwind/.prettierignore
diff --git a/packages/css2tailwind/CHANGELOG.md → css2tailwind/CHANGELOG.md b/packages/css2tailwind/CHANGELOG.md → css2tailwind/CHANGELOG.md
diff --git a/packages/css2tailwind/README.md → css2tailwind/README.md b/packages/css2tailwind/README.md → css2tailwind/README.md
diff --git a/packages/css2tailwind/eslint.config.js → css2tailwind/eslint.config.js b/packages/css2tailwind/eslint.config.js → css2tailwind/eslint.config.js
diff --git a/packages/css2tailwind/package.json → css2tailwind/package.json b/packages/css2tailwind/package.json → css2tailwind/package.json
diff --git a/packages/css2tailwind/src/bin.cjs → css2tailwind/src/bin.cjs b/packages/css2tailwind/src/bin.cjs → css2tailwind/src/bin.cjs
diff --git a/packages/css2tailwind/src/build.ts → css2tailwind/src/build.ts b/packages/css2tailwind/src/build.ts → css2tailwind/src/build.ts
diff --git a/packages/css2tailwind/src/cli.ts → css2tailwind/src/cli.ts b/packages/css2tailwind/src/cli.ts → css2tailwind/src/cli.ts
diff --git a/packages/css2tailwind/src/compiler.ts → css2tailwind/src/compiler.ts b/packages/css2tailwind/src/compiler.ts → css2tailwind/src/compiler.ts
diff --git a/packages/css2tailwind/src/error.ts → css2tailwind/src/error.ts b/packages/css2tailwind/src/error.ts → css2tailwind/src/error.ts
diff --git a/packages/css2tailwind/src/util.ts → css2tailwind/src/util.ts b/packages/css2tailwind/src/util.ts → css2tailwind/src/util.ts
diff --git a/packages/css2tailwind/tsconfig.json → css2tailwind/tsconfig.json b/packages/css2tailwind/tsconfig.json → css2tailwind/tsconfig.json
diff --git a/packages/css2tailwind/tsup.config.ts → css2tailwind/tsup.config.ts b/packages/css2tailwind/tsup.config.ts → css2tailwind/tsup.config.ts
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -1,3 +1,3 @@
 packages:
   - 'examples/*'
-  - 'packages/*'
+  - 'css2tailwind'