From 96a2026f9d18fac29e9dd1386a803e4dd6b8bded Mon Sep 17 00:00:00 2001 From: felix-b Date: Sat, 20 Apr 2019 06:33:42 +0300 Subject: [PATCH] Update README --- README.md | 14 ++++++++++---- docs/intro.md | 21 +++++++++++++-------- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3e482421..bc0a6d37 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,25 @@ # Welcome to NWheels -An ejectable way to develop and maintain software of any scale with tiny amount of code, written in DSLs dedicated to every layer and aspect. [Read full introduction](docs/). +An ejectable way to develop and maintain software of any scale with tiny amount of code in domain-specific langauges (DSL). Every layer and aspect have dedicated DSLs, which allow declaring intents through code, together with arbitrary logic. The DSLs are then transpiled into working codebases in selected languages and technology stacks. [Read full introduction](docs/). -> CURRENT STATUS: incubation of **v2**. The field-tested **v1** can be found in the [this branch](https://github.com/nwheels-io/NWheels/tree/gen-1). +CURRENT STATUS: incubation of **v2**. The field-tested **v1** can be found in [gen-1 branch](https://github.com/nwheels-io/NWheels/tree/gen-1). # Getting started WARNING: we're in early alpha, expect failures -## Prerequisites +## Prerequisites + +### Production + + + +### Development - Machine running Linux, macOS, or Windows - .NET Core SDK 2.1 or higher -- A C# IDE. The popular ones are VSCode, Visual Studio (Windows only), Rider +- (Recommended) C# IDE. The popular ones are VSCode, Visual Studio (Windows only), Rider ## Hello World diff --git a/docs/intro.md b/docs/intro.md index 90489f1f..67069dae 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -11,12 +11,12 @@ ## Who NWheels is good for: -- **[Greenfield projects]()**: work both fast and right, starting on day one -- **[Startups]()**: a crazy shortcut, you probably won't need angels -- **[Freelance]()**: complete projects lightning fast -- **[Prototyping or scaffolding]()**: instant visible results and feedback from business -- **[Designing domain models]()**: try what-if alternative designs in no time, picking up the winner -- **[Willing to go DDD]()**: DDD DSL greatly lowers the costs, more projects will profit +- **[Greenfield projects]()**: work both fast and right, starting on day one [[Explain]()] +- **[Startups]()**: game changer, you probably won't need angels [[Explain]()] +- **[Freelance]()**: complete projects lightning fast [[Explain]()] +- **[Prototyping or scaffolding]()**: instant visible results and feedback from business [[Explain]()] +- **[Designing domain models]()**: try what-if alternative designs in no time, picking up the winner [[Explain]()] +- **[Willing to go DDD]()**: DSLs allow for low-cost DDD, most projects would profit [[Explain]()] ## How it works: @@ -30,9 +30,14 @@ ## What are the drawbacks? -NWheels is a cutting edge approach, with all the associated consequences. +NWheels is a cutting edge approach, with all the associated consequences. But you can always use the Eject button. -If anything goes wrong, you are able to eject at any moment: drop the DSLs, and start maintaining generated codebase. The generated code contains no traces of NWheels. +## Eject button + +If anything goes wrong, you are able to eject at any moment: + +- drop the DSLs, and start maintaining generated codebase +- the generated code contains no traces of NWheels ## Can it actually work?