Skip to content

Commit 8f1f7d3

Browse files
chore: update readme
1 parent 445abdc commit 8f1f7d3

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,35 +49,29 @@ The template includes automated setup scripts for different operating systems:
4949

5050
## 🔧 Build, Deploy and Maintenance
5151

52-
This template includes comprehensive build automation using the [NUKE](https://nuke.build/) build system. You can easily user them in your [CI/CD](.github/workflows) pipelines or run them locally.
52+
This template includes comprehensive build automation that covers compilation, linting, and testing. The build system is already integrated into the CI workflow at `.github/workflows/ci.yml`.
5353

54+
#### Local Build Scripts
5455

56+
For convenience, we've provided scripts to run build tasks locally:
5557

56-
| Location | Purpose |
57-
|----------------|----------|---------|
58+
| Script Location | Purpose |
59+
|----------------|----------|
5860
| `src/4-Build/scripts/compile/` | Builds the entire solution |
5961
| `src/4-Build/scripts/lint/` | Runs code quality checks |
6062
| `src/4-Build/scripts/tests/` | Executes unit and integration tests |
6163
| `src/4-Build/scripts/packages/` | Updates CodeBlock Dev Kit NuGet packages |
6264

63-
### Running Build Scripts
65+
For detailed build system documentation, see the [Build README](src/4-Build/README.md).
6466

65-
For detailed information about the build system, see the [Build README](src/4-Build/README.md).
67+
#### CI/CD Configuration
6668

67-
### Continuous Integration & Deployment
69+
- **CI Workflow** (`.github/workflows/ci.yml`): Pre-configured to build, test, and package your application
70+
- **CD Workflow** (`.github/workflows/cd.yml`): Configured for Windows IIS deployment
6871

69-
The template includes pre-configured CI/CD workflows:
72+
You can modify these workflows based on your deployment environment. The template is not limited to any specific platform - you can deploy to cloud services, Linux servers, Windows servers, or any other environment of your choice.
7073

71-
- **CI Workflow** (`.github/workflows/ci.yml`): Builds, tests, and packages your application
72-
- **CD Workflow** (`.github/workflows/cd.yml`): Deploys to Windows IIS server
73-
74-
**Customizing for Your Environment:**
75-
76-
1. **Modify CI Workflow**: Update `.github/workflows/ci.yml` to match your build requirements
77-
2. **Configure CD Workflow**: Customize `.github/workflows/cd.yml` for your deployment target:
78-
- For Linux deployment: Change runner to `ubuntu-latest`
79-
- For cloud deployment: Update deployment steps for your cloud provider
80-
- For different platforms: Modify build commands and artifact packaging
74+
For detailed CI/CD guidance, refer to the [CodeBlock Dev Kit Documentation](https://docs.codeblock.dev/).
8175

8276
# 🚀 Implement Your Logic and Build Your SaaS
8377

0 commit comments

Comments
 (0)